Skip to main content
Skip table of contents

Project

DELETE /Project/{id}

Deletes the record by its session identifier. (projectDeleteById)

Path parameters

id (required)

Path Parameter — The session ID of the record. format: uuid

Responses

  • 204: The record is successfully deleted.

  • 401: The user is not logged in to the system.

  • 500: Internal server error.

DELETE /Project/{ids}

Deletes the record by the values of its key fields. (projectDeleteByKeys)

Path parameters

ids (required)

Path Parameter — The values of the key fields of the record.

Responses

  • 204: The record is successfully deleted.

  • 401: The user is not logged in to the system.

  • 500: Internal server error.

GET /Project/$adHocSchema

Retrieves the schema of custom fields of the entity from the system. (projectGetAdHocSchema)

Return type

Project

Example data

Content-Type: application/json

{

"blank": true,

"bytes": [],

"empty": true

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

  • text/json

Responses

  • 200: The field name, view name, and type of the fields that are not defined in the contract of the endpoint for this entity.

  • 401: The user is not logged in to the system.

  • 500: Internal server error.

GET /Project/{id}

Retrieves a record by the value of the session entity ID from the system. (projectGetById)

Path parameters

id (required)

Path Parameter — The session ID of the record. format: uuid

Query parameters

$select (optional)

Query Parameter — The fields of the entity to be returned from the system.

$filter (optional)

Query Parameter — The conditions that determine which records should be selected from the system.

$expand (optional)

Query Parameter — The linked and detail entities that should be expanded.

$custom (optional)

Query Parameter — The fields that are not defined in the contract of the endpoint to be returned from the system.

Return type

Project

Example data

Content-Type: application/json

{

"blank": true,

"bytes": [],

"empty": true

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

  • text/json

Responses

  • 200: The requested record.

  • 401: The user is not logged in to the system.

  • 500: Internal server error.

GET /Project/{ids}

Retrieves a record by the values of its key fields from the system. (projectGetByKeys)

Path parameters

ids (required)

Path Parameter — The values of the key fields of the record.

Query parameters

$select (optional)

Query Parameter — The fields of the entity to be returned from the system.

$filter (optional)

Query Parameter — The conditions that determine which records should be selected from the system.

$expand (optional)

Query Parameter — The linked and detail entities that should be expanded.

$custom (optional)

Query Parameter — The fields that are not defined in the contract of the endpoint to be returned from the system.

Return type

Project

Example data

Content-Type: application/json

{

"blank": true,

"bytes": [],

"empty": true

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

  • text/json

Responses

  • 200: The requested record.

  • 401: The user is not logged in to the system.

  • 500: Internal server error.

GET /Project

Retrieves records that satisfy the specified conditions from the system. (projectGetList)

Query parameters

$select (optional)

Query Parameter — The fields of the entity to be returned from the system.

$filter (optional)

Query Parameter — The conditions that determine which records should be selected from the system.

$expand (optional)

Query Parameter — The linked and detail entities that should be expanded.

$custom (optional)

Query Parameter — The fields that are not defined in the contract of the endpoint to be returned from the system.

$skip (optional)

Query Parameter — The number of records to be skipped from the list of returned records. format: int32

$top (optional)

Query Parameter — The number of records to be returned from the system. format: int32

Return type

array[Project]

Example data

Content-Type: application/json

{}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

  • text/json

Responses

  • 200: The list of records that satisfy the specified conditions.

  • 401: The user is not logged in to the system.

  • 500: Internal server error.

POST /Project/ActivateProject

Performs an action in the system. (projectInvokeActionActivateProject)

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

  • text/json

Request body

invocation ActivateProject (required)

Body Parameter — The record to which the action should be applied and the parameters of the action.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

  • text/json

Responses

  • 202: The operation is in progress.

  • 204: The operation that was initiated by the action is completed.

  • 400: The data specified in the request is invalid.

  • 401: The user is not logged in to the system.

  • 412: Either the header of the request specifies that the entity has to be inserted but an entity with these keys already exists in the database and cannot be inserted, or the header specifies that the entity has to be updated but there is no entity with these keys in the database.

  • 422: The data specified in the request is invalid.

  • 500: Internal server error.

POST /Project/ApproveProject

Performs an action in the system. (projectInvokeActionApproveProject)

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

  • text/json

Request body

invocation ApproveProject (required)

Body Parameter — The record to which the action should be applied and the parameters of the action.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

  • text/json

Responses

  • 202: The operation is in progress.

  • 204: The operation that was initiated by the action is completed.

  • 400: The data specified in the request is invalid.

  • 401: The user is not logged in to the system.

  • 412: Either the header of the request specifies that the entity has to be inserted but an entity with these keys already exists in the database and cannot be inserted, or the header specifies that the entity has to be updated but there is no entity with these keys in the database.

  • 422: The data specified in the request is invalid.

  • 500: Internal server error.

POST /Project/CancelProject

Performs an action in the system. (projectInvokeActionCancelProject)

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

  • text/json

Request body

invocation CancelProject (required)

Body Parameter — The record to which the action should be applied and the parameters of the action.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

  • text/json

Responses

  • 202: The operation is in progress.

  • 204: The operation that was initiated by the action is completed.

  • 400: The data specified in the request is invalid.

  • 401: The user is not logged in to the system.

  • 412: Either the header of the request specifies that the entity has to be inserted but an entity with these keys already exists in the database and cannot be inserted, or the header specifies that the entity has to be updated but there is no entity with these keys in the database.

  • 422: The data specified in the request is invalid.

  • 500: Internal server error.

POST /Project/ChangeProjectID

Performs an action in the system. (projectInvokeActionChangeProjectID)

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

  • text/json

Request body

invocation ChangeProjectID (required)

Body Parameter — The record to which the action should be applied and the parameters of the action.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

  • text/json

Responses

  • 202: The operation is in progress.

  • 204: The operation that was initiated by the action is completed.

  • 400: The data specified in the request is invalid.

  • 401: The user is not logged in to the system.

  • 412: Either the header of the request specifies that the entity has to be inserted but an entity with these keys already exists in the database and cannot be inserted, or the header specifies that the entity has to be updated but there is no entity with these keys in the database.

  • 422: The data specified in the request is invalid.

  • 500: Internal server error.

POST /Project/CompleteProject

Performs an action in the system. (projectInvokeActionCompleteProject)

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

  • text/json

Request body

invocation CompleteProject (required)

Body Parameter — The record to which the action should be applied and the parameters of the action.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

  • text/json

Responses

  • 202: The operation is in progress.

  • 204: The operation that was initiated by the action is completed.

  • 400: The data specified in the request is invalid.

  • 401: The user is not logged in to the system.

  • 412: Either the header of the request specifies that the entity has to be inserted but an entity with these keys already exists in the database and cannot be inserted, or the header specifies that the entity has to be updated but there is no entity with these keys in the database.

  • 422: The data specified in the request is invalid.

  • 500: Internal server error.

POST /Project/{actionName}

Performs an action in the system. (projectInvokeActionCustomAction)

Path parameters

actionName (required)

Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

  • text/json

Request body

invocation ProjectCustomAction (required)

Body Parameter — The record to which the action should be applied and the parameters of the action.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

  • text/json

Responses

  • 202: The operation is in progress.

  • 204: The operation that was initiated by the action is completed.

  • 400: The data specified in the request is invalid.

  • 401: The user is not logged in to the system.

  • 412: Either the header of the request specifies that the entity has to be inserted but an entity with these keys already exists in the database and cannot be inserted, or the header specifies that the entity has to be updated but there is no entity with these keys in the database.

  • 422: The data specified in the request is invalid.

  • 500: Internal server error.

POST /Project/HoldProject

Performs an action in the system. (projectInvokeActionHoldProject)

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

  • text/json

Request body

invocation HoldProject (required)

Body Parameter — The record to which the action should be applied and the parameters of the action.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

  • text/json

Responses

  • 202: The operation is in progress.

  • 204: The operation that was initiated by the action is completed.

  • 400: The data specified in the request is invalid.

  • 401: The user is not logged in to the system.

  • 412: Either the header of the request specifies that the entity has to be inserted but an entity with these keys already exists in the database and cannot be inserted, or the header specifies that the entity has to be updated but there is no entity with these keys in the database.

  • 422: The data specified in the request is invalid.

  • 500: Internal server error.

POST /Project/LockProjectBudget

Performs an action in the system. (projectInvokeActionLockProjectBudget)

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

  • text/json

Request body

invocation LockProjectBudget (required)

Body Parameter — The record to which the action should be applied and the parameters of the action.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

  • text/json

Responses

  • 202: The operation is in progress.

  • 204: The operation that was initiated by the action is completed.

  • 400: The data specified in the request is invalid.

  • 401: The user is not logged in to the system.

  • 412: Either the header of the request specifies that the entity has to be inserted but an entity with these keys already exists in the database and cannot be inserted, or the header specifies that the entity has to be updated but there is no entity with these keys in the database.

  • 422: The data specified in the request is invalid.

  • 500: Internal server error.

POST /Project/LockProjectCommitments

Performs an action in the system. (projectInvokeActionLockProjectCommitments)

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

  • text/json

Request body

invocation LockProjectCommitments (required)

Body Parameter — The record to which the action should be applied and the parameters of the action.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

  • text/json

Responses

  • 202: The operation is in progress.

  • 204: The operation that was initiated by the action is completed.

  • 400: The data specified in the request is invalid.

  • 401: The user is not logged in to the system.

  • 412: Either the header of the request specifies that the entity has to be inserted but an entity with these keys already exists in the database and cannot be inserted, or the header specifies that the entity has to be updated but there is no entity with these keys in the database.

  • 422: The data specified in the request is invalid.

  • 500: Internal server error.

POST /Project/RejectProject

Performs an action in the system. (projectInvokeActionRejectProject)

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

  • text/json

Request body

invocation RejectProject (required)

Body Parameter — The record to which the action should be applied and the parameters of the action.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

  • text/json

Responses

  • 202: The operation is in progress.

  • 204: The operation that was initiated by the action is completed.

  • 400: The data specified in the request is invalid.

  • 401: The user is not logged in to the system.

  • 412: Either the header of the request specifies that the entity has to be inserted but an entity with these keys already exists in the database and cannot be inserted, or the header specifies that the entity has to be updated but there is no entity with these keys in the database.

  • 422: The data specified in the request is invalid.

  • 500: Internal server error.

POST /Project/RunProjectAllocation

Performs an action in the system. (projectInvokeActionRunProjectAllocation)

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

  • text/json

Request body

invocation RunProjectAllocation (required)

Body Parameter — The record to which the action should be applied and the parameters of the action.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

  • text/json

Responses

  • 202: The operation is in progress.

  • 204: The operation that was initiated by the action is completed.

  • 400: The data specified in the request is invalid.

  • 401: The user is not logged in to the system.

  • 412: Either the header of the request specifies that the entity has to be inserted but an entity with these keys already exists in the database and cannot be inserted, or the header specifies that the entity has to be updated but there is no entity with these keys in the database.

  • 422: The data specified in the request is invalid.

  • 500: Internal server error.

POST /Project/RunProjectBilling

Performs an action in the system. (projectInvokeActionRunProjectBilling)

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

  • text/json

Request body

invocation RunProjectBilling (required)

Body Parameter — The record to which the action should be applied and the parameters of the action.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

  • text/json

Responses

  • 202: The operation is in progress.

  • 204: The operation that was initiated by the action is completed.

  • 400: The data specified in the request is invalid.

  • 401: The user is not logged in to the system.

  • 412: Either the header of the request specifies that the entity has to be inserted but an entity with these keys already exists in the database and cannot be inserted, or the header specifies that the entity has to be updated but there is no entity with these keys in the database.

  • 422: The data specified in the request is invalid.

  • 500: Internal server error.

POST /Project/SuspendProject

Performs an action in the system. (projectInvokeActionSuspendProject)

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

  • text/json

Request body

invocation SuspendProject (required)

Body Parameter — The record to which the action should be applied and the parameters of the action.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

  • text/json

Responses

  • 202: The operation is in progress.

  • 204: The operation that was initiated by the action is completed.

  • 400: The data specified in the request is invalid.

  • 401: The user is not logged in to the system.

  • 412: Either the header of the request specifies that the entity has to be inserted but an entity with these keys already exists in the database and cannot be inserted, or the header specifies that the entity has to be updated but there is no entity with these keys in the database.

  • 422: The data specified in the request is invalid.

  • 500: Internal server error.

POST /Project/UnlockProjectBudget

Performs an action in the system. (projectInvokeActionUnlockProjectBudget)

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

  • text/json

Request body

invocation UnlockProjectBudget (required)

Body Parameter — The record to which the action should be applied and the parameters of the action.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

  • text/json

Responses

  • 202: The operation is in progress.

  • 204: The operation that was initiated by the action is completed.

  • 400: The data specified in the request is invalid.

  • 401: The user is not logged in to the system.

  • 412: Either the header of the request specifies that the entity has to be inserted but an entity with these keys already exists in the database and cannot be inserted, or the header specifies that the entity has to be updated but there is no entity with these keys in the database.

  • 422: The data specified in the request is invalid.

  • 500: Internal server error.

POST /Project/UnlockProjectCommitments

Performs an action in the system. (projectInvokeActionUnlockProjectCommitments)

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

  • text/json

Request body

invocation UnlockProjectCommitments (required)

Body Parameter — The record to which the action should be applied and the parameters of the action.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

  • text/json

Responses

  • 202: The operation is in progress.

  • 204: The operation that was initiated by the action is completed.

  • 400: The data specified in the request is invalid.

  • 401: The user is not logged in to the system.

  • 412: Either the header of the request specifies that the entity has to be inserted but an entity with these keys already exists in the database and cannot be inserted, or the header specifies that the entity has to be updated but there is no entity with these keys in the database.

  • 422: The data specified in the request is invalid.

  • 500: Internal server error.

POST /Project/ValidateProjectBalance

Performs an action in the system. (projectInvokeActionValidateProjectBalance)

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

  • text/json

Request body

invocation ValidateProjectBalance (required)

Body Parameter — The record to which the action should be applied and the parameters of the action.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

  • text/json

Responses

  • 202: The operation is in progress.

  • 204: The operation that was initiated by the action is completed.

  • 400: The data specified in the request is invalid.

  • 401: The user is not logged in to the system.

  • 412: Either the header of the request specifies that the entity has to be inserted but an entity with these keys already exists in the database and cannot be inserted, or the header specifies that the entity has to be updated but there is no entity with these keys in the database.

  • 422: The data specified in the request is invalid.

  • 500: Internal server error.

PUT /Project

Creates a record or updates an existing record. (projectPutEntity)

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

  • text/json

Request body

entity Project (required)

Body Parameter — The record to be passed to the system.

Query parameters

$select (optional)

Query Parameter — The fields of the entity to be returned from the system.

$filter (optional)

Query Parameter — The conditions that determine which records should be selected from the system.

$expand (optional)

Query Parameter — The linked and detail entities that should be expanded.

$custom (optional)

Query Parameter — The fields that are not defined in the contract of the endpoint to be returned from the system.

Return type

Project

Example data

Content-Type: application/json

{

"blank": true,

"bytes": [],

"empty": true

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

  • text/json

Responses

  • 200: The created or updated record.

  • 400: The data specified in the request is invalid.

  • 401: The user is not logged in to the system.

  • 412: Either the header of the request specifies that the entity has to be inserted but an entity with these keys already exists in the database and cannot be inserted, or the header specifies that the entity has to be updated but there is no entity with these keys in the database.

  • 422: The data specified in the request is invalid.

  • 500: Internal server error.

PUT /Project/{ids}/files/{filename}

Attaches a file to a record. (projectPutFile)

Path parameters

ids (required)

Path Parameter — The values of the key fields of the record.

filename (required)

Path Parameter — The name of the file that you are going to attach with the extension.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

  • text/json

Responses

  • 204: The file is successfully attached.

  • 401: The user is not logged in to the system.

  • 500: Internal server error.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close