Automation Suggestions

PreviousAutomations & Self-Service Actions NextBlueprints

Last updated 8 months ago

Was this helpful?

Get Suggestions

get

/api/v1/suggestions

Authorizations

Query parameters

searchQuerySearchquery

filtersFilters

sortsSorts

cursorCursor

sizeSize

includeTotalIncludetotal

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v1/suggestions' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

422

{
  "total": 1,
  "current_page": "text",
  "current_page_backwards": "text",
  "previous_page": "text",
  "next_page": "text",
  "items": [
    {
      "id": "text",
      "title": "text",
      "description": "text",
      "originType": "automation",
      "originId": "text",
      "sourceType": "entity",
      "sourceId": "text",
      "sourceContext": {},
      "targetType": "entity",
      "targetId": "text",
      "targetContext": {},
      "targetIdOverride": "text",
      "data": {},
      "ignored": false,
      "autoApply": false,
      "lastAppliedAt": "2025-02-21T18:08:12.083Z",
      "createdAt": "2025-02-21T18:08:12.083Z",
      "createdBy": 1,
      "updatedAt": "2025-02-21T18:08:12.083Z",
      "updatedBy": 1,
      "additionalInfo": {}
    }
  ]
}

Successful Response

Create Suggestion

post

/api/v1/suggestions

Authorizations

Body

idId

Pattern: ^([a-z0-9_.-]+)$

titleTitlerequired

descriptionDescription

originTypeOriginTyperequired

An enumeration.

Options: automation

originIdOriginidrequired

sourceTypeSourceTyperequired

An enumeration.

Options: entity

sourceIdSourceidrequired

sourceContextSourcecontext

targetTypeTargetTyperequired

An enumeration.

Options: entity

targetIdTargetidrequired

targetContextTargetcontext

targetIdOverrideTargetidoverride

dataData

ignoredIgnored

autoApplyAutoapply

lastAppliedAtLastappliedat

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v1/suggestions' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"title":"text","originType":"automation","originId":"text","sourceType":"entity","sourceId":"text","sourceContext":{},"targetType":"entity","targetId":"text","targetContext":{},"data":{},"ignored":false,"autoApply":false}'

201

422

{
  "id": "text",
  "title": "text",
  "description": "text",
  "originType": "automation",
  "originId": "text",
  "sourceType": "entity",
  "sourceId": "text",
  "sourceContext": {},
  "targetType": "entity",
  "targetId": "text",
  "targetContext": {},
  "targetIdOverride": "text",
  "data": {},
  "ignored": false,
  "autoApply": false,
  "lastAppliedAt": "2025-02-21T18:08:12.083Z",
  "createdAt": "2025-02-21T18:08:12.083Z",
  "createdBy": 1,
  "updatedAt": "2025-02-21T18:08:12.083Z",
  "updatedBy": 1,
  "additionalInfo": {}
}

Successful Response

Get Suggestion

get

/api/v1/suggestions/{id_}

Authorizations

Path parameters

id_Id required

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v1/suggestions/{id_}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

422

{
  "id": "text",
  "title": "text",
  "description": "text",
  "originType": "automation",
  "originId": "text",
  "sourceType": "entity",
  "sourceId": "text",
  "sourceContext": {},
  "targetType": "entity",
  "targetId": "text",
  "targetContext": {},
  "targetIdOverride": "text",
  "data": {},
  "ignored": false,
  "autoApply": false,
  "lastAppliedAt": "2025-02-21T18:08:12.083Z",
  "createdAt": "2025-02-21T18:08:12.083Z",
  "createdBy": 1,
  "updatedAt": "2025-02-21T18:08:12.083Z",
  "updatedBy": 1,
  "additionalInfo": {}
}

Successful Response

Upsert Suggestion

put

/api/v1/suggestions/{id_}

Authorizations

Path parameters

id_Id required

Pattern: ^([a-z0-9_.-]+)$

Body

idId

Pattern: ^([a-z0-9_.-]+)$

titleTitlerequired

descriptionDescription

originTypeOriginTyperequired

An enumeration.

Options: automation

originIdOriginidrequired

sourceTypeSourceTyperequired

An enumeration.

Options: entity

sourceIdSourceidrequired

sourceContextSourcecontext

targetTypeTargetTyperequired

An enumeration.

Options: entity

targetIdTargetidrequired

targetContextTargetcontext

targetIdOverrideTargetidoverride

dataData

ignoredIgnored

autoApplyAutoapply

lastAppliedAtLastappliedat

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/v1/suggestions/{id_}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"title":"text","originType":"automation","originId":"text","sourceType":"entity","sourceId":"text","sourceContext":{},"targetType":"entity","targetId":"text","targetContext":{},"data":{}}'

200

422

{
  "id": "text",
  "title": "text",
  "description": "text",
  "originType": "automation",
  "originId": "text",
  "sourceType": "entity",
  "sourceId": "text",
  "sourceContext": {},
  "targetType": "entity",
  "targetId": "text",
  "targetContext": {},
  "targetIdOverride": "text",
  "data": {},
  "ignored": false,
  "autoApply": false,
  "lastAppliedAt": "2025-02-21T18:08:12.083Z",
  "createdAt": "2025-02-21T18:08:12.083Z",
  "createdBy": 1,
  "updatedAt": "2025-02-21T18:08:12.083Z",
  "updatedBy": 1,
  "additionalInfo": {}
}

Successful Response

Delete Suggestion

delete

/api/v1/suggestions/{id_}

Authorizations

Path parameters

id_Id required

Pattern: ^([a-z0-9_.-]+)$

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/v1/suggestions/{id_}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

204

422

No body

Successful Response

Apply Suggestion

post

/api/v1/suggestions/{id_}/apply

Authorizations

Path parameters

id_Id required

Pattern: ^([a-z0-9_.-]+)$

Query parameters

dryRunDry run applying suggestion and output changes

enableAutoApplyEnable auto-apply flag

deleteAfterApplyDelete suggestion after apply

Body

targetIdOverrideTargetidoverride

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v1/suggestions/{id_}/apply' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json'

200

422

{
  "dryRun": true,
  "ignored": true,
  "previousState": {},
  "newState": {}
}

Successful Response