Projects (projects)

Requests

HTTP verb Endpoint Description

POST

/rest/v1/domain/projects

Creating a new project

GET

/rest/v1/domain/projects

Getting the list of projects

GET

/rest/v1/domain/projects/<id>

Getting project data

PATCH

/rest/v1/domain/projects/<id>

Modifying project data

DELETE

/rest/v1/domain/projects/<id>

Deleting a project

LOOKUP

/rest/v1/domain/projects

Searching for a project identifier


Creating a new project

Request

Field description: project entity

Example request
POST /rest/v1/domain/projects HTTP/1.1
Content-Type: application/json; charset=utf-8

project entity

Response

Field description: project entity

Example response
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

Table 1. Request parameters
Name Type Description

filter

object

Filter by field values.

mask

str

List of fields to output. Available fields for output: id, code, name, opts.title, ext.lwt, ext.ct.

offset

int

Offset in the list of resources to output.

limit

int

Maximum number of resources in the list.

order

array<object|str>

Sorting order of resources in the list.

flat

bool

Transformation of composite fields to flat form.

Example request
GET /rest/v1/domain/projects?offset=0&limit=2 HTTP/1.1

Response

Field description: project entity

Example response
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"
    }
  }
]

Getting project data

Request

Table 2. Request parameters
Name Type Description

mask

str

List of fields to output.

flat

bool

Transformation of composite fields to flat form.

Example request
GET /rest/v1/domain/projects/866c3624-016c-d34e-07a7-50e54938780c HTTP/1.1

Response

Field description: project entity

Example response
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"
  }
}

Modifying project data

Fields prohibited for modification: id

Request

Field description: project entity

Example request
PATCH /rest/v1/domain/projects/866c3624-016c-d34e-07a7-50e54938780c HTTP/1.1
Content-Type: application/json; charset=utf-8

project entity

Response

Field description: project entity

Example response
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

Request

Example request
DELETE /rest/v1/domain/projects/866c3624-016c-d34e-07a7-50e54938780c HTTP/1.1

Response

Example response
HTTP/1.1 204 No Content

Searching for a project identifier

Searches for a resource by the specified key and returns the identifier(s) for building the endpoint.

Key fields for search: id, code

Request

Example request
LOOKUP /rest/v1/domain/projects HTTP/1.1
Content-Type: application/json; charset=utf-8

"5102"

Response

Example successful response
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8

[
  "866c3624-016c-d34e-07a7-50e54938780c"
]
Example failed response
HTTP/1.1 404 Not Found
Content-Type: application/json; charset=utf-8

{
  "error_code": 1404,
  "error_message": "Lookup failed"
}