API docs by Redocly

CoManage.External.API (v1)

Download OpenAPI specification:

Models - v1

Retrieve a paginated list of project models.

This endpoint uses cursor-based pagination. If additional records exist, the response will contain a nextPageKey. Pass this key into the afterId query parameter of your next request to retrieve the subsequent page.

Authorizations:
ProjectApiKeyHeaderProjectApiKeyQuery
query Parameters
afterId
integer <int64>

The cursor for pagination. Use the nextPageKey from a previous response to fetch the next page.

Responses

Response samples

Content type
No sample

Objects - v1

Retrieve a paginated list of COMANAGE objects of type "TYPE".

This endpoint uses cursor-based pagination. If additional records exist, the response will contain a nextPageKey. Pass this key into the afterId query parameter of your next request to retrieve the subsequent page.

Authorizations:
ProjectApiKeyHeaderProjectApiKeyQuery
query Parameters
afterId
integer <int64>

The cursor for pagination. Use the nextPageKey from a previous response to fetch the next page.

Responses

Response samples

Content type
No sample

Retrieve a paginated list of COMANAGE objects of type "INSTANCE".

This endpoint uses cursor-based pagination. If additional records exist, the response will contain a nextPageKey. Pass this key into the afterId query parameter of your next request to retrieve the subsequent page.

Authorizations:
ProjectApiKeyHeaderProjectApiKeyQuery
query Parameters
afterId
integer <int64>

The cursor for pagination. Use the nextPageKey from a previous response to fetch the next page.

Responses

Response samples

Content type
No sample

Retrieve a paginated list of COMANAGE object views.

This endpoint uses cursor-based pagination. If additional records exist, the response will contain a nextPageKey. Pass this key into the afterId query parameter of your next request to retrieve the subsequent page.

Authorizations:
ProjectApiKeyHeaderProjectApiKeyQuery
query Parameters
afterId
integer <int64>

The cursor for pagination. Use the nextPageKey from a previous response to fetch the next page.

Responses

Response samples

Content type
No sample

Retrieve a paginated list of COMANAGE objects for a specific view.

This endpoint uses cursor-based pagination. If additional records exist, the response will contain a nextPageKey. Pass this key into the afterId query parameter of your next request to retrieve the subsequent page.

Authorizations:
ProjectApiKeyHeaderProjectApiKeyQuery
path Parameters
viewId
required
integer <int64>

The unique identifier of the view for which to retrieve COMANAGE objects.

query Parameters
afterId
integer <int64>

The cursor for pagination. Use the nextPageKey from a previous response to fetch the next page.

Responses

Response samples

Content type
No sample

ProjectUsers - v1

Retrieve a paginated list of project users.

This endpoint uses cursor-based pagination. If additional records exist, the response will contain a nextPageKey. Pass this key into the afterId query parameter of your next request to retrieve the subsequent page.

Authorizations:
ProjectApiKeyHeaderProjectApiKeyQuery
query Parameters
afterId
integer <int64>

The cursor for pagination. Use the nextPageKey from a previous response to fetch the next page.

Responses

Response samples

Content type
No sample

Properties - v1

Retrieve a paginated list of project properties.

This endpoint uses cursor-based pagination. If additional records exist, the response will contain a nextPageKey. Pass this key into the afterId query parameter of your next request to retrieve the subsequent page.

Authorizations:
ProjectApiKeyHeaderProjectApiKeyQuery
query Parameters
afterId
integer <int64>

The cursor for pagination. Use the nextPageKey from a previous response to fetch the next page.

Responses

Response samples

Content type
No sample