Home Page > Integration > REST API > Projects


Projects - /REST/1/Projects/:id

This endpoint is used for manipulating Project resources within the system. Objects are always returned in a JSON format within an array. Empty results return an empty array.



The Project resource is represented with the following JSON object:

 ​    {
 ​        "alive": "<bool>",
 ​        "code": "<string>",
 ​        "code_alias_1": "<string>",
 ​        "code_alias_2": "<string>",
 ​        "id": "<int>",
 ​        "name": "<string>",
 ​        "name_alias_1": "<string>",
 ​        "name_alias_2": "<string>"
 ​    }



As with other resources, this resource is subject to the global parameters mentioned in the REST Overview.



The following JSON parameters are available when updating a resource:


JSON Parameter Allowed values
alive bool
code string
code_alias_1 string
code_alias_2 string
name string
name_alias_1 string
name_alias_2 string


Possible Errors

Sending an invalid project code (based on system preferences):

curl -H "Authorization: Basic YWRtaW46YWRtaW4=" \
  http://my.openasset.example.org/REST/1/Projects/5 \
  -D -X PUT \
  -d '{"code": ""}'

Will result in the following response:

HTTP/1.1 400 Bad Request

   "error_message" : "Invalid project code",
   "http_status_code" : "400"



The following JSON parameters are required when creating a resource:


JSON Parameters Allowed values
name string
code string


The remaining fields mentioned in the PUT method are also available in the POST method.



The resource can be deleted using this verb and including the id in the endpoint URL. 

Last modified


This page has no custom tags.


This page has no classifications.