Automation Suggestions

Get Suggestions

GET/api/v1/suggestions

Query parameters

Response

Successful Response

Body

items*Items

totalTotal

Total items

current_pageCurrent Page

Cursor to refetch the current page

current_page_backwardsCurrent Page Backwards

Cursor to refetch the current page starting from the last item

previous_pagePrevious Page

Cursor for the previous page

next_pageNext Page

Cursor for the next page

Request

const response = await fetch('/api/v1/suggestions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "items": [
    {
      "id": "text",
      "title": "text",
      "description": "text",
      "originType": "automation",
      "originId": "text",
      "sourceType": "entity",
      "sourceId": "text",
      "targetType": "entity",
      "targetId": "text",
      "targetIdOverride": "text",
      "ignored": false,
      "autoApply": false,
      "lastAppliedAt": "2025-01-20T18:58:04.951Z",
      "createdAt": "2025-01-20T18:58:04.951Z",
      "createdBy": 0,
      "updatedAt": "2025-01-20T18:58:04.951Z",
      "updatedBy": 0
    }
  ],
  "total": 0,
  "current_page": "text",
  "current_page_backwards": "text",
  "previous_page": "text",
  "next_page": "text"
}

Create Suggestion

POST/api/v1/suggestions

Body

idId

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

title*Title

descriptionDescription

originType*OriginType

An enumeration.

automation

originId*Originid

sourceType*SourceType

An enumeration.

entity

sourceId*Sourceid

sourceContextSourcecontext

targetType*TargetType

An enumeration.

entity

targetId*Targetid

targetContextTargetcontext

targetIdOverrideTargetidoverride

dataData

ignoredIgnored

autoApplyAutoapply

lastAppliedAtLastappliedat

Response

Successful Response

Body

idId

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

title*Title

descriptionDescription

originType*OriginType

An enumeration.

automation

originId*Originid

sourceType*SourceType

An enumeration.

entity

sourceId*Sourceid

sourceContextSourcecontext

targetType*TargetType

An enumeration.

entity

targetId*Targetid

targetContextTargetcontext

targetIdOverrideTargetidoverride

dataData

ignoredIgnored

autoApplyAutoapply

lastAppliedAtLastappliedat

createdAt*Createdat

createdByCreatedby

updatedAt*Updatedat

updatedByUpdatedby

additionalInfoAdditionalinfo

Request

const response = await fetch('/api/v1/suggestions', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "title": "text",
      "originType": "automation",
      "originId": "text",
      "sourceType": "entity",
      "sourceId": "text",
      "targetType": "entity",
      "targetId": "text"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "title": "text",
  "description": "text",
  "originType": "automation",
  "originId": "text",
  "sourceType": "entity",
  "sourceId": "text",
  "targetType": "entity",
  "targetId": "text",
  "targetIdOverride": "text",
  "ignored": false,
  "autoApply": false,
  "lastAppliedAt": "2025-01-20T18:58:04.951Z",
  "createdAt": "2025-01-20T18:58:04.951Z",
  "createdBy": 0,
  "updatedAt": "2025-01-20T18:58:04.951Z",
  "updatedBy": 0
}

Get Suggestion

GET/api/v1/suggestions/{id_}

Path parameters

id_*Id

Response

Successful Response

Body

idId

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

title*Title

descriptionDescription

originType*OriginType

An enumeration.

automation

originId*Originid

sourceType*SourceType

An enumeration.

entity

sourceId*Sourceid

sourceContextSourcecontext

targetType*TargetType

An enumeration.

entity

targetId*Targetid

targetContextTargetcontext

targetIdOverrideTargetidoverride

dataData

ignoredIgnored

autoApplyAutoapply

lastAppliedAtLastappliedat

createdAt*Createdat

createdByCreatedby

updatedAt*Updatedat

updatedByUpdatedby

additionalInfoAdditionalinfo

Request

const response = await fetch('/api/v1/suggestions/{id_}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "text",
  "title": "text",
  "description": "text",
  "originType": "automation",
  "originId": "text",
  "sourceType": "entity",
  "sourceId": "text",
  "targetType": "entity",
  "targetId": "text",
  "targetIdOverride": "text",
  "ignored": false,
  "autoApply": false,
  "lastAppliedAt": "2025-01-20T18:58:04.951Z",
  "createdAt": "2025-01-20T18:58:04.951Z",
  "createdBy": 0,
  "updatedAt": "2025-01-20T18:58:04.951Z",
  "updatedBy": 0
}

Upsert Suggestion

PUT/api/v1/suggestions/{id_}

Path parameters

id_*Id

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

Body

idId

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

title*Title

descriptionDescription

originType*OriginType

An enumeration.

automation

originId*Originid

sourceType*SourceType

An enumeration.

entity

sourceId*Sourceid

sourceContextSourcecontext

targetType*TargetType

An enumeration.

entity

targetId*Targetid

targetContextTargetcontext

targetIdOverrideTargetidoverride

dataData

ignoredIgnored

autoApplyAutoapply

lastAppliedAtLastappliedat

Response

Successful Response

Body

idId

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

title*Title

descriptionDescription

originType*OriginType

An enumeration.

automation

originId*Originid

sourceType*SourceType

An enumeration.

entity

sourceId*Sourceid

sourceContextSourcecontext

targetType*TargetType

An enumeration.

entity

targetId*Targetid

targetContextTargetcontext

targetIdOverrideTargetidoverride

dataData

ignoredIgnored

autoApplyAutoapply

lastAppliedAtLastappliedat

createdAt*Createdat

createdByCreatedby

updatedAt*Updatedat

updatedByUpdatedby

additionalInfoAdditionalinfo

Request

const response = await fetch('/api/v1/suggestions/{id_}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "title": "text",
      "originType": "automation",
      "originId": "text",
      "sourceType": "entity",
      "sourceId": "text",
      "targetType": "entity",
      "targetId": "text"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "title": "text",
  "description": "text",
  "originType": "automation",
  "originId": "text",
  "sourceType": "entity",
  "sourceId": "text",
  "targetType": "entity",
  "targetId": "text",
  "targetIdOverride": "text",
  "ignored": false,
  "autoApply": false,
  "lastAppliedAt": "2025-01-20T18:58:04.951Z",
  "createdAt": "2025-01-20T18:58:04.951Z",
  "createdBy": 0,
  "updatedAt": "2025-01-20T18:58:04.951Z",
  "updatedBy": 0
}

Delete Suggestion

DELETE/api/v1/suggestions/{id_}

Path parameters

id_*Id

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

Response

Successful Response

Request

const response = await fetch('/api/v1/suggestions/{id_}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

Apply Suggestion

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

Path parameters

id_*Id

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

Query parameters

Body

targetIdOverrideTargetidoverride

Response

Successful Response

Body

dryRunDryrun

ignoredIgnored

previousStatePreviousstate

newStateNewstate

Request

const response = await fetch('/api/v1/suggestions/{id_}/apply', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "dryRun": false,
  "ignored": false
}

PreviousAutomations & Self-Service Actions NextBlueprints

Last updated 7 months ago