serviceIdstringrequired
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
documentIdstringrequired
The id of the document.
Example:7b453ae4-66f5-4530-88b0-0b6e34072325
Move Catalog Service Document
Moves a service document.
post
Path Parameters
Body
application/json
Body
application/json
Move document
move document request payload
parent_document_idstring(uuid)
parent document id
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
indexinteger
index of the document in the parent document’s children
Example:1
Response
Response
The service document has been moved
post/catalog-services/{serviceId}/documents/{documentId}/move
Authentication
Path Parameters
Body
{
"parent_document_id": "71a10e4f-8def-44db-b9b2-88823f41b5e8",
"index": 0
}
Suggested Resource Actions
Provides suggested actions to take on resources. Suggested actions are generated from suggestion rules.
List Suggested Resource Actions
Returns a paginated collection of a suggested resource actions.
get
Query Parameters
page[size]integer
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
page[number]integer
Determines which page of the entities to retrieve.
Example:1
filterobject
Filters a collection of suggested resource actions.
* Additional properties are NOT allowed.
Show Child Parameters
sortstring
The asc suffix is optional as the default sort order is ascending.
The desc suffix is used to specify a descending order.
Multiple sort attributes may be provided via a comma separated list.
JSONPath notation may be used to specify a sub-attribute (eg: ‘foo.bar desc’).
Example:created_at desc
Response
application/json
Response
application/json
A paginated list response for a collection of suggested resource actions.
* Additional properties are NOT allowed.
metaobjectrequired
returns the pagination information
Show Child Parameters
dataarrayrequired
Contains information about a suggested resource action
Show Child Parameters
get/suggested-resource-actions
Authentication
Query Parameters
application/json
Get a Suggested Resource Action
Returns information about a suggested resource action.
get
Path Parameters
suggestedResourceActionIdstringrequired
ID of the suggested resource action.
Example:76ca0689-f08e-4c04-b2a6-4c992d89d554
Response
application/json
Response
application/json
A response containg a suggested resource action object.
SuggestedResourceAction
Contains information about a suggested resource action
idstringrequired
The suggested resource action rule ID.
Example:76ca0689-f08e-4c04-b2a6-4c992d89d554
integrationobjectrequired
Short-hand descriptor of an integration installed within the catalog.
Show Child Parameters
suggestion_rule_idstring | null(uuid)required
The identifier of the suggestion rule that generated this suggested resource action.
Example:22f72bd1-2897-473e-9471-302de3ccf38b
entity_namestringrequired
The entity name of the discovered entity associated to this suggested action.
Example:My Service
service_idstring | null(uuid)required
The identifier of the service this suggested resource action may act on.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
ignoredbooleanrequired
Determines if this suggested action has been ignored or not.
true: Suggested action has been ignoredfalse: Suggested action is ready to be accepted or ignored
Example:false
action
One Ofrequired
ArchiveActionPayloadobject
* Additional properties are NOT allowed.
Show Child Parameters
created_atstring(date-time)read-only
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
updated_atstring(date-time)read-only
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
get/suggested-resource-actions/{suggestedResourceActionId}
Authentication
Path Parameters
application/json
Update Suggested Resource Action
Updates the given suggested resource.
patch
Path Parameters
suggestedResourceActionIdstringrequired
ID of the suggested resource action.
Example:76ca0689-f08e-4c04-b2a6-4c992d89d554
Body
application/json
Body
application/json
Request body schema for updating a suggested resource action.
UpdateSuggestedResourceAction
Payload to update a suggested resource action.
* Additional properties are NOT allowed.
ignoredbooleanrequired
Determines if this suggested action has been ignored or not.
true: Suggested action has been ignoredfalse: Suggested action is ready to be accepted or ignored
Example:false
Response
application/json
Response
application/json
A response containg a suggested resource action object.
SuggestedResourceAction
Contains information about a suggested resource action
idstringrequired
The suggested resource action rule ID.
Example:76ca0689-f08e-4c04-b2a6-4c992d89d554
integrationobjectrequired
Short-hand descriptor of an integration installed within the catalog.
Show Child Parameters
suggestion_rule_idstring | null(uuid)required
The identifier of the suggestion rule that generated this suggested resource action.
Example:22f72bd1-2897-473e-9471-302de3ccf38b
entity_namestringrequired
The entity name of the discovered entity associated to this suggested action.
Example:My Service
service_idstring | null(uuid)required
The identifier of the service this suggested resource action may act on.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
ignoredbooleanrequired
Determines if this suggested action has been ignored or not.
true: Suggested action has been ignoredfalse: Suggested action is ready to be accepted or ignored
Example:false
action
One Ofrequired
ArchiveActionPayloadobject
* Additional properties are NOT allowed.
Show Child Parameters
created_atstring(date-time)read-only
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
updated_atstring(date-time)read-only
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
patch/suggested-resource-actions/{suggestedResourceActionId}
Authentication
Path Parameters
Body
{
"ignored": false
}
application/json