Create or Modify Folder

Request : GET /papi/v1/project/folder

Save a new folder or edit an existing one. If the folder Id = 0 or is not defined then the folder is saved as a new.

Parameter Parameter Type Mandatory Description
Folder Object Body yes Folder object. Check the folder data model definitions from the swagger documentation https://grano.emmi.fi/papi/v1/swagger/ui/index#!/Project/POST_project_folder
x-auth-token Header yes The authentication token must be provided as an x-auth-token header for every API request.
More information about authentication token.

Response: Folder Id (string).

cURL example creating a new folder to the root hierarchy.

curl --location --request POST 'https://[EMMi instance]/papi/v1/project/folder' \
--header 'Content-Type: application/json' \
--header 'x-auth-token: [Session token]' \
--data-raw '{
    "Id": "0",
    "ParentId": "0",
    "Name": "My First EMMi Folder to Project Management"
}'

Get Project Folder Information

Request : GET /papi/v1/Folder/[Folder id]

Function for getting the basic information of a project folder. The folder object is identical to the project object excluding the proof, asset, task/milestone, conversation information.

Parameter Parameter Type Mandatory Description
Folder Id Path yes Unique folder id.
x-auth-token Header yes The authentication token must be provided as an x-auth-token header for every API request.
More information about authentication token.

Response: JSON – Folder object.

{
    "Id": "75",
    "ParentId": "0",
    "Name": "Folder for Amazing Projects",
    "Members": [
        {
            "ProjectRoleId": "1",
            "UserId": "25",
            "UserFullName": "Jonh Average"
        },
        {
            "ProjectRoleId": "2",
            "UserId": "61",
            "UserFullName": "Mary Mediocre"
        }
    ],
    "PropertyValues": [
        {
            "FieldIdentifier": "43",
            "Value": {
                "x-default": "This is a description of the project."
            }
        }
    ]
}

cURL example

curl --location --request POST 'https://[EMMi instance]/papi/v1/Folder/[Folder id] \
--header 'x-auth-token: [Session token]'

Feedback

Was this helpful?

Yes No
You indicated this topic was not helpful to you ...
Could you please leave a comment telling us why? Thank you!
Thanks for your feedback.

Post your comment on this topic.

Post Comment