Projects (projects)
Requests
| HTTP verb | Endpoint | Description |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Creating a new project
Request
Field Description: project entity
POST /rest/v1/domain/projects HTTP/1.1
Content-Type: application/json; charset=utf-8
project entityResponse
Field Description: project entity
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"id": "866c3624-016c-d34e-07a7-50e54938780c",
"code": "5102",
"name": "ProjectY",
"opts": {
"title": "",
"comment": ""
},
"ext": {
"ct": "2019-08-27T13:40:02.87Z",
"lwt": "2019-08-27T13:40:02.87Z"
}
}Getting the list of projects
Request
| Name | Type | Description |
|---|---|---|
|
|
Filter by field values. |
|
|
List of fields to output. Available fields for output: id, code, name, opts.title, ext.lwt, ext.ct. |
|
|
Offset in the list of resources to be issued. |
|
|
The maximum number of resources in the list. |
|
|
The sort order of the resources in the list. |
|
|
Conversion to flat form of composite fields. |
GET /rest/v1/domain/projects?offset=0&limit=2 HTTP/1.1Response
Field Description: project entity
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
[
{
"id": "54e07833-016c-d34d-dc92-50e54938780c",
"code": "5101",
"name": "ProjectX",
"ext": {
"ct": "2019-08-27T13:38:55.14Z",
"lwt": "2019-08-27T13:38:55.14Z"
}
},
{
"id": "866c3624-016c-d34e-07a7-50e54938780c",
"code": "5102",
"name": "ProjectY",
"ext": {
"ct": "2019-08-27T13:40:02.87Z",
"lwt": "2019-08-27T13:40:02.87Z"
}
}
]Obtaining project data
Request
| Name | Type | Description |
|---|---|---|
|
|
A list of fields to output. |
|
|
Conversion to flat form of composite fields. |
GET /rest/v1/domain/projects/866c3624-016c-d34e-07a7-50e54938780c HTTP/1.1Response
Field Description: project entity
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"id": "866c3624-016c-d34e-07a7-50e54938780c",
"code": "5102",
"name": "ProjectY",
"opts": {
"title": "",
"comment": ""
},
"ext": {
"ct": "2019-08-27T13:40:02.87Z",
"lwt": "2019-08-27T13:40:02.87Z"
}
}Changing project data
Fields prohibited for modification: id
Request
Field Description: project entity
PATCH /rest/v1/domain/projects/866c3624-016c-d34e-07a7-50e54938780c HTTP/1.1
Content-Type: application/json; charset=utf-8
project entityResponse
Field Description: project entity
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"id": "866c3624-016c-d34e-07a7-50e54938780c",
"code": "5102",
"name": "ProjectY",
"opts": {
"title": "",
"comment": ""
},
"ext": {
"ct": "2019-08-27T13:40:02.87Z",
"lwt": "2019-09-11T10:39:54.27Z"
}
}Deleting a project
Searching for a project identifier
Searches the resource for the specified key, returns the identifier(s) to build the endpoint.
Key fields to search for: id, code
Request
LOOKUP /rest/v1/domain/projects HTTP/1.1
Content-Type: application/json; charset=utf-8
"5102"Response
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
[
"866c3624-016c-d34e-07a7-50e54938780c"
]HTTP/1.1 404 Not Found
Content-Type: application/json; charset=utf-8
{
"error_code": 1404,
"error_message": "Lookup failed"
}