NovaDB CMS API

Branches

Create, read, update and delete branches

Cms_GetBranch

Get a single branch by ID

Request
GET /branches/{id}[?attributes&variants&languages]
Parameters
Name Type Default Notes
*id string

The branch ID, Guid or ApiIdentifier
attributes string

A comma separated list of object IDs, Guids or ApiIdentifiers to filter down values by attributes
variants string

A comma separated list of object IDs, Guids or ApiIdentifiers to filter down values by variants
languages string

A comma separated list of object IDs, Guids or ApiIdentifiers to filter down values by languages
Responses
Status Code Type Description Samples
200

OK
304

The content has not been modified
400

Bad request parameter
403
404

The branch or object could not be found

Cms_UpdateBranch

Update a branch

Request
PATCH /branches/{id}
Parameters
Name Type Default Notes
*id string

The branch ID, Guid or ApiIdentifier
X-CmsApi-Username string

The username this transaction is committed for. This must be set for internal access, otherwise, the transaction will be committed as the user who is currently logged in.
Responses
Status Code Type Description Samples
200

OK
400

Bad request parameter
403

Forbidden
404

The branch could not be found

Cms_DeleteBranch

Deletes a branch by ID

Request
DELETE /branches/{id}
Parameters
Name Type Default Notes
*id string

The branch ID, Guid or ApiIdentifier
X-CmsApi-Username string

The username this transaction is committed for. This must be set for internal access, otherwise, the transaction will be committed as the user who is currently logged in.
Responses
Status Code Type Description Samples
200

OK
400

Bad request parameter
403

Forbidden
404

The branch or object could not be found

Cms_CreateBranch

Create a branch

Request
POST /branches
Parameters
Name Type Default Notes
X-CmsApi-Username string

The username this transaction is committed for. This must be set for internal access, otherwise, the transaction will be committed as the user who is currently logged in.
Responses
Status Code Type Description Samples
200

OK
400

Bad request parameter
403

Forbidden

Code Generator

Create source code for business classes from the CMS object types

CodeGenerator_GetCSharpClasses

Get generated class implementation for all objects with API identifiers

Request
GET /branches/{branch}/generators/{language}/types[?ids]
Parameters
Name Type Default Notes
*branch string

The branch ID or ApiIdentifier
*language string

The programming language of the generated code
ids string

A comma separated list of object type IDs, Guids or ApiIdentifiers or "all" for all custom object types that have an API Identifier
Responses
Status Code Type Description Samples
200

OK
400

Bad request parameter

CodeGenerator_GetCSharpClass

Get a c# class for a specific object type

Request
GET /branches/{branch}/generators/{language}/types/{type}
Parameters
Name Type Default Notes
*branch string

The branch ID or ApiIdentifier
*language string

The programming language of the generated code
*type string

The object type ID or ApiIdentifier
Responses
Status Code Type Description Samples
200

OK
400

Bad request parameter

Comments

Create, read, update and delete comments

Comment_CreateComment

Create a comment.

Request
POST /comments
Parameters
Name Type Default Notes
X-CmsApi-Username string

The username this transaction is committed for. This must be set for internal access, otherwise, the transaction will be committed as the user who is currently logged in.
Responses
Status Code Type Description Samples
200

OK
400

Bad request parameter
403

Forbidden
404

The branch or the object could not be found

Comment_GetComments

Get multiple comments, sorted by id, descending.

Request
GET /comments[?branchRef&objectRef&user&isDeleted&continue&take]
Parameters
Name Type Default Notes
branchRef integer (int32)

The id of the branch.
objectRef integer (int32)

The id of object the comment refers to.
user string

The user who wrote the comment. If not null, only comments created by the specified user will be included.
isDeleted boolean

If true, include only deleted, if false include only not-deleted, if null include all comments.
continue string

An opaque token that encapsulates information how to continue the list request
take integer (int32)

The number of comments to take.
Responses
Status Code Type Description Samples
200

OK
400

Bad request parameter.
403

Forbidden
404

The branch or the comment could not be found.

Comment_GetComment

Get a single comment by ID

Request
GET /comments/{commentId}
Parameters
Name Type Default Notes
*commentId integer (int64)

The comment's ID.
Responses
Status Code Type Description Samples
200

OK
403

Forbidden
404

The branch or the comment could not be found.

Comment_DeleteComment

Deletes a comment.

Request
DELETE /comments/{commentId}
Parameters
Name Type Default Notes
*commentId integer (int64)

The comment's id.
X-CmsApi-Username string

The username this transaction is committed for. This must be set for internal access, otherwise, the transaction will be committed as the user who is currently logged in.
Responses
Status Code Type Description Samples
200

OK
400

Bad request parameter
403

Forbidden
404

The comment could not be found

Comment_UpdateComment

Updates a comment.

Request
PATCH /comments/{commentId}
Parameters
Name Type Default Notes
*commentId integer (int64)

The comment id.
X-CmsApi-Username string

The username this transaction is committed for. This must be set for internal access, otherwise, the transaction will be committed as the user who is currently logged in.
Responses
Status Code Type Description Samples
200

OK
400

Bad request parameter
403

Forbidden
404

The comment was not found or it is deleted.

Files

Upload and download external binaries (files)

Files_GetFile

Retrieve the file with the specified name.

Retrieve the file with the specified name.

Request
GET /files/{name}
Parameters
Name Type Default Notes
*name string

Name of the file including the extension.
range string

Range header value. For more information, visit https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Range
Responses
Status Code Type Description Samples
200

Ok
206

Partial Content
304

Not Modified
400

Bad Request
404

File Not Found

Files_StartUpload

Start uploading an external file.

Start uploading an external file.

Request
POST /fileUpload
Responses
Status Code Type Description Samples
200

Ok
400

Bad Request
403

Forbidden
413

Payload Too Large
422

The file size is larger than expected.

Files_ContinueUpload

Continue uploading an external file.

Continue uploading an external file.

Request
PUT /fileUpload/{token}
Parameters
Name Type Default Notes
*token string

The token of the temporary file.
Responses
Status Code Type Description Samples
200

Ok
400

Bad Request
403

Forbidden
413

Payload Too Large
422

The file size is larger than expected.

Files_DeleteTempFile

Delete the temporary file using the provided token.

Delete the temporary file using the provided token.

Request
DELETE /fileUpload/{token}
Parameters
Name Type Default Notes
*token string

Token for the temporary file to delete (including extension).
Responses
Status Code Type Description Samples
200

Ok
400

Bad Request
403

Forbidden

Identities

Read user data

Identity_GetUserDisplayName

Gets a user's display name.

Request
GET /users/{name}
Parameters
Name Type Default Notes
*name string

The user's name.
Responses
Status Code Type Description Samples
200

OK
304

The content has not been modified
400

Bad request parameter
403
404

The branch or object could not be found
422

The object id is not unique

Jobs

Create, read, update and delete jobs

Job_CreateJob

Create a job.

Request
POST /jobs
Parameters
Name Type Default Notes
X-CmsApi-Username string

The username this transaction is committed for. This must be set for internal access, otherwise, the transaction will be committed as the user who is currently logged in.
Responses
Status Code Type Description Samples
200
400
403
404

Job_GetJobs

Get Jobs

Request
GET /jobs[?branchId&definitionRef&state&triggerRef&createdBy&isDeleted&continue&take]
Parameters
Name Type Default Notes
branchId integer (int32)

The id of the branch.
definitionRef integer (int32)

The id of the job definition.
state

Job state. if null, all states will be included. (0=New, 1=Running, 2=Succeeded, 3=Error, 4=KillRequest, 5=RestartRequest)
triggerRef integer (int32)

If not null, only jobs triggered by the specified Id will be included.
createdBy string

Job Created by. If not null, only jobs created by the specified user will be included.
isDeleted boolean

If true, include only deleted, if false include only not-deleted, if null include all jobs.
continue string

An opaque token that encapsulates information how to continue the list request
take integer (int32)

The number of jobs to take.
Responses
Status Code Type Description Samples
200

OK
400

Bad request parameter.
403
404

The branch or job could not be found.

Job_GetJob

Get a single job by ID

Request
GET /jobs/{jobId}
Parameters
Name Type Default Notes
*jobId integer (int32)

The job ID.
Responses
Status Code Type Description Samples
200

OK
403
404

The branch or job could not be found.

Job_UpdateJob

Updates a job.

Request
PATCH /jobs/{jobId}
Parameters
Name Type Default Notes
*jobId integer (int32)

The job id.
X-CmsApi-Username string

The username this transaction is committed for. This must be set for internal access, otherwise, the transaction will be committed as the user who is currently logged in.
Responses
Status Code Type Description Samples
200
400
403
404

Job_DeleteJob

Deletes a job.

Request
DELETE /jobs/{jobId}
Parameters
Name Type Default Notes
*jobId integer (int32)

The job id.
X-CmsApi-Username string

The username this transaction is committed for. This must be set for internal access, otherwise, the transaction will be committed as the user who is currently logged in.
Responses
Status Code Type Description Samples
200
400
403
404

Job_GetJobMetrics

Get job metrics by Job Id

Request
GET /jobs/{jobId}/metrics[?maxItems]
Parameters
Name Type Default Notes
*jobId integer (int32)

The job ID.
maxItems integer (int32)

Optional parameter to limit the number of metric points returned.
Responses
Status Code Type Description Samples
200

OK
403

Forbidden
404

The job could not be found.

Job_GetJobProgress

Get job progress information by Job Id

Request
GET /jobs/{jobId}/progress
Parameters
Name Type Default Notes
*jobId integer (int32)

The job ID.
Responses
Status Code Type Description Samples
200

OK
403

Forbidden
404

The job could not be found.

Job_GetJobObjectIds

Gets the ids of the job's context objects.

Request
GET /jobs/{jobId}/objectIds
Parameters
Name Type Default Notes
*jobId integer (int32)

The job id.
Responses
Status Code Type Description Samples
200
400
403
404

Job_GetJobLogs

Get job logs by Job Id

Request
GET /jobs/{jobId}/logs
Parameters
Name Type Default Notes
*jobId integer (int32)

The job ID.
Responses
Status Code Type Description Samples
200

OK
403

Forbidden
404

The branch or job could not be found.

Job_GetJobArtifactsZip

Get job artifacts by Job Id as a ZIP file

Request
GET /jobs/{jobId}/artifacts.zip
Parameters
Name Type Default Notes
*jobId integer (int32)

The job ID.
Responses
Status Code Type Description Samples
200

OK
400

Bad request parameter.
404

The job does not have artifacts.

Job_GetJobArtifacts

Provides a listing of job artifacts.

Request
GET /jobs/{jobId}/artifacts
Parameters
Name Type Default Notes
*jobId integer (int32)

The job ID.
Responses
Status Code Type Description Samples
200

OK
400

Bad request parameter.
404

The job does not have artifacts.

Job_GetJobArtifact

Get a single artifact file.

Request
GET /jobs/{jobId}/artifacts/{path}
Parameters
Name Type Default Notes
*jobId integer (int32)

The job ID.
*path string

The relative path of the file.
Responses
Status Code Type Description Samples
200

OK
400

Bad request parameter.
404

The job does not have artifacts.

Job_JobInputUpload

Start uploading a file to be used as job input.

Request
POST /jobInput
Responses
Status Code Type Description Samples
200

Ok
400

Bad Request
403

Forbidden
413

Payload Too Large
422

The file size is larger than expected.

Job_JobInputContinue

Continue uploading a file to be used as job input.

Request
POST /jobInput/{token}
Parameters
Name Type Default Notes
*token string

The key of the temporary data
Responses
Status Code Type Description Samples
200

Ok
400

Bad Request
403

Forbidden
413

Payload Too Large
422

The file size is larger than expected.

Job_JobInputCancel

Cancel uploading a file to be used as job input.

Request
DELETE /jobInput/{token}
Parameters
Name Type Default Notes
*token string

The key of the temporary data
Responses
Status Code Type Description Samples
200

Ok
400

Bad Request
403

Forbidden

Objects

Create, read, update and delete objects

Cms_GetObject

Get a single object by ID

Request
GET /branches/{branch}/objects/{id}[?inherited&attributes&variants&languages]
Parameters
Name Type Default Notes
*branch string

The branch ID, Guid or ApiIdentifier
*id string

The object ID, Guid or ApiIdentifier
inherited boolean

Include inherited values
attributes string

A comma separated list of object IDs, Guids or ApiIdentifiers to filter down values by attributes
variants string

A comma separated list of object IDs, Guids or ApiIdentifiers to filter down values by variants
languages string

A comma separated list of object IDs, Guids or ApiIdentifiers to filter down values by languages
Responses
Status Code Type Description Samples
200

OK
304

The content has not been modified
400

Bad request parameter
403
404

The branch or object could not be found
422

The object id is not unique

Cms_GetObjects

Get multiple objects by ID

Request
GET /branches/{branch}/objects?ids[&inherited&attributes&variants&languages]
Parameters
Name Type Default Notes
*branch string

The branch ID, Guid or ApiIdentifier
*ids string

A comma separated list of object IDs, Guids or ApiIdentifiers
inherited boolean

Include inherited values
attributes string

A comma separated list of object IDs, Guids or ApiIdentifiers to filter down values by attributes
variants string

A comma separated list of object IDs, Guids or ApiIdentifiers to filter down values by variants
languages string

A comma separated list of object IDs, Guids or ApiIdentifiers to filter down values by languages
Responses
Status Code Type Description Samples
200

OK
304

The content has not been modified
400

Bad request parameter
403
404

The branch or object could not be found

Cms_CreateObjects

Create objects

Request
POST /branches/{branch}/objects
Parameters
Name Type Default Notes
*branch string

The branch ID, Guid or ApiIdentifier
X-CmsApi-Username string

The username this transaction is committed for. This must be set for internal access, otherwise, the transaction will be committed as the user who is currently logged in.
Responses
Status Code Type Description Samples
201

Object(s) Created
400

Bad request parameter
403

Forbidden
404

The branch could not be found

Cms_UpdateObjects

Update objects

Request
PATCH /branches/{branch}/objects
Parameters
Name Type Default Notes
*branch string

The branch ID, Guid or ApiIdentifier
X-CmsApi-Username string

The username this transaction is committed for. This must be set for internal access, otherwise, the transaction will be committed as the user who is currently logged in.
Responses
Status Code Type Description Samples
200

OK
400

Bad request parameter
403

Forbidden
404

The branch or object could not be found

Cms_DeleteObjects

Delete objects by ID

Request
DELETE /branches/{branch}/objects
Parameters
Name Type Default Notes
*branch string

The branch ID, Guid or ApiIdentifier
X-CmsApi-Username string

The username this transaction is committed for. This must be set for internal access, otherwise, the transaction will be committed as the user who is currently logged in.
Responses
Status Code Type Description Samples
200

OK
400

Bad request parameter
403

Forbidden
404

The branch or object could not be found

Cms_GetTypedObjects

Get objects of a type

Request
GET /branches/{branch}/types/{type}/objects[?deleted&inherited&continue&take&attributes&variants&languages]
Parameters
Name Type Default Notes
*branch string

The branch ID, Guid or ApiIdentifier
*type string

The object type ID, Guid or ApiIdentifier
deleted boolean

Value of the deleted flag (default: return deleted and undeleted objects)
inherited boolean

Include inherited values
continue string

The token for the next objects
take integer (int32)

The number of objects to take
attributes string

A comma separated list of object IDs, Guids or ApiIdentifiers to filter down values by attributes
variants string

A comma separated list of object IDs, Guids or ApiIdentifiers to filter down values by variants
languages string

A comma separated list of object IDs, Guids or ApiIdentifiers to filter down values by languages
Responses
Status Code Type Description Samples
200

OK
304

The content has not been modified
400

Bad request parameter
403
404

The branch or object could not be found
422

The object id is not unique