Heartwork API

AtomicScripts

Endpointhttps://api.heart.work

Download schema

GET

https://api.heart.work

/core-api/atomicscripts

query Parameters

Take

integer · int32

Skip

integer · int32

SortOrder

string · enum

Enum values:

Asc

Desc

SortBy

string · enum

Enum values:

Title

Query

string

ids

string[]

external_references

string[]

Responses

object[] · required

total

integer · int32 · required

GET/core-api/atomicscripts

curl --request GET \
  --url https://api.heart.work/core-api/atomicscripts

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "title": "title",
      "atomicName": "atomicName",
      "atomicScriptType": "BeforeAtomic",
      "script": "script",
      "enabled": true,
      "continueOnError": true,
      "timeout": 0,
      "order": 0
    }
  ],
  "total": 0
}

plain

POST

https://api.heart.work

/core-api/atomicscripts

Request Body

title

string · required

atomicName

string · required

atomicScriptType

string · enum · required

Enum values:

BeforeAtomic

AfterAtomic

script

string · required

enabled

boolean · required

continueOnError

boolean · required

timeout

integer · int32 · required

order

integer · int32 · required

externalReference

string

Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

title

string · required

atomicName

string · required

atomicScriptType

string · enum · required

Enum values:

BeforeAtomic

AfterAtomic

script

string · required

enabled

boolean · required

continueOnError

boolean · required

timeout

integer · int32 · required

order

integer · int32 · required

externalReference

string

POST/core-api/atomicscripts

curl --request POST \
  --url https://api.heart.work/core-api/atomicscripts \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalReference": "externalReference",
  "title": "title",
  "atomicName": "atomicName",
  "atomicScriptType": "BeforeAtomic",
  "script": "script",
  "enabled": true,
  "continueOnError": true,
  "timeout": 0,
  "order": 0
}
'

shell

Example Request Body

{
  "externalReference": "externalReference",
  "title": "title",
  "atomicName": "atomicName",
  "atomicScriptType": "BeforeAtomic",
  "script": "script",
  "enabled": true,
  "continueOnError": true,
  "timeout": 0,
  "order": 0
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "title": "title",
  "atomicName": "atomicName",
  "atomicScriptType": "BeforeAtomic",
  "script": "script",
  "enabled": true,
  "continueOnError": true,
  "timeout": 0,
  "order": 0
}

plain

GET

https://api.heart.work

/core-api/atomicscripts/{id}

path Parameters

id

string · required

Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

title

string · required

atomicName

string · required

atomicScriptType

string · enum · required

Enum values:

BeforeAtomic

AfterAtomic

script

string · required

enabled

boolean · required

continueOnError

boolean · required

timeout

integer · int32 · required

order

integer · int32 · required

externalReference

string

GET/core-api/atomicscripts/{id}

curl --request GET \
  --url https://api.heart.work/core-api/atomicscripts/:id

shell

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "title": "title",
  "atomicName": "atomicName",
  "atomicScriptType": "BeforeAtomic",
  "script": "script",
  "enabled": true,
  "continueOnError": true,
  "timeout": 0,
  "order": 0
}

plain

PUT

https://api.heart.work

/core-api/atomicscripts/{id}

path Parameters

id

string · required

Request Body

title

string · required

atomicName

string · required

atomicScriptType

string · enum · required

Enum values:

BeforeAtomic

AfterAtomic

script

string · required

enabled

boolean · required

continueOnError

boolean · required

timeout

integer · int32 · required

order

integer · int32 · required

id

string · required

externalReference

string

Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

title

string · required

atomicName

string · required

atomicScriptType

string · enum · required

Enum values:

BeforeAtomic

AfterAtomic

script

string · required

enabled

boolean · required

continueOnError

boolean · required

timeout

integer · int32 · required

order

integer · int32 · required

externalReference

string

PUT/core-api/atomicscripts/{id}

curl --request PUT \
  --url https://api.heart.work/core-api/atomicscripts/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalReference": "externalReference",
  "title": "title",
  "atomicName": "atomicName",
  "atomicScriptType": "BeforeAtomic",
  "script": "script",
  "enabled": true,
  "continueOnError": true,
  "timeout": 0,
  "order": 0,
  "id": "id"
}
'

shell

Example Request Body

{
  "externalReference": "externalReference",
  "title": "title",
  "atomicName": "atomicName",
  "atomicScriptType": "BeforeAtomic",
  "script": "script",
  "enabled": true,
  "continueOnError": true,
  "timeout": 0,
  "order": 0,
  "id": "id"
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "title": "title",
  "atomicName": "atomicName",
  "atomicScriptType": "BeforeAtomic",
  "script": "script",
  "enabled": true,
  "continueOnError": true,
  "timeout": 0,
  "order": 0
}

plain

DELETE

https://api.heart.work

/core-api/atomicscripts/{id}

path Parameters

id

string · required

Responses

No data returned

DELETE/core-api/atomicscripts/{id}

curl --request DELETE \
  --url https://api.heart.work/core-api/atomicscripts/:id

shell

Example Responses

No example specified for this content type

Apps Auth

Heartwork API

AtomicScripts

Endpointhttps://api.heart.work

Download schema

GET

https://api.heart.work

/core-api/atomicscripts

query Parameters

Take

integer · int32

Skip

integer · int32

SortOrder

string · enum

Enum values:

Asc

Desc

SortBy

string · enum

Enum values:

Title

Query

string

ids

string[]

external_references

string[]

Responses

object[] · required

total

integer · int32 · required

GET/core-api/atomicscripts

curl --request GET \
  --url https://api.heart.work/core-api/atomicscripts

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "title": "title",
      "atomicName": "atomicName",
      "atomicScriptType": "BeforeAtomic",
      "script": "script",
      "enabled": true,
      "continueOnError": true,
      "timeout": 0,
      "order": 0
    }
  ],
  "total": 0
}

plain

POST

https://api.heart.work

/core-api/atomicscripts

Request Body

title

string · required

atomicName

string · required

atomicScriptType

string · enum · required

Enum values:

BeforeAtomic

AfterAtomic

script

string · required

enabled

boolean · required

continueOnError

boolean · required

timeout

integer · int32 · required

order

integer · int32 · required

externalReference

string

Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

title

string · required

atomicName

string · required

atomicScriptType

string · enum · required

Enum values:

BeforeAtomic

AfterAtomic

script

string · required

enabled

boolean · required

continueOnError

boolean · required

timeout

integer · int32 · required

order

integer · int32 · required

externalReference

string

POST/core-api/atomicscripts

curl --request POST \
  --url https://api.heart.work/core-api/atomicscripts \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalReference": "externalReference",
  "title": "title",
  "atomicName": "atomicName",
  "atomicScriptType": "BeforeAtomic",
  "script": "script",
  "enabled": true,
  "continueOnError": true,
  "timeout": 0,
  "order": 0
}
'

shell

Example Request Body

{
  "externalReference": "externalReference",
  "title": "title",
  "atomicName": "atomicName",
  "atomicScriptType": "BeforeAtomic",
  "script": "script",
  "enabled": true,
  "continueOnError": true,
  "timeout": 0,
  "order": 0
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "title": "title",
  "atomicName": "atomicName",
  "atomicScriptType": "BeforeAtomic",
  "script": "script",
  "enabled": true,
  "continueOnError": true,
  "timeout": 0,
  "order": 0
}

plain

GET

https://api.heart.work

/core-api/atomicscripts/{id}

path Parameters

id

string · required

Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

title

string · required

atomicName

string · required

atomicScriptType

string · enum · required

Enum values:

BeforeAtomic

AfterAtomic

script

string · required

enabled

boolean · required

continueOnError

boolean · required

timeout

integer · int32 · required

order

integer · int32 · required

externalReference

string

GET/core-api/atomicscripts/{id}

curl --request GET \
  --url https://api.heart.work/core-api/atomicscripts/:id

shell

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "title": "title",
  "atomicName": "atomicName",
  "atomicScriptType": "BeforeAtomic",
  "script": "script",
  "enabled": true,
  "continueOnError": true,
  "timeout": 0,
  "order": 0
}

plain

PUT

https://api.heart.work

/core-api/atomicscripts/{id}

path Parameters

id

string · required

Request Body

title

string · required

atomicName

string · required

atomicScriptType

string · enum · required

Enum values:

BeforeAtomic

AfterAtomic

script

string · required

enabled

boolean · required

continueOnError

boolean · required

timeout

integer · int32 · required

order

integer · int32 · required

id

string · required

externalReference

string

Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

title

string · required

atomicName

string · required

atomicScriptType

string · enum · required

Enum values:

BeforeAtomic

AfterAtomic

script

string · required

enabled

boolean · required

continueOnError

boolean · required

timeout

integer · int32 · required

order

integer · int32 · required

externalReference

string

PUT/core-api/atomicscripts/{id}

curl --request PUT \
  --url https://api.heart.work/core-api/atomicscripts/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalReference": "externalReference",
  "title": "title",
  "atomicName": "atomicName",
  "atomicScriptType": "BeforeAtomic",
  "script": "script",
  "enabled": true,
  "continueOnError": true,
  "timeout": 0,
  "order": 0,
  "id": "id"
}
'

shell

Example Request Body

{
  "externalReference": "externalReference",
  "title": "title",
  "atomicName": "atomicName",
  "atomicScriptType": "BeforeAtomic",
  "script": "script",
  "enabled": true,
  "continueOnError": true,
  "timeout": 0,
  "order": 0,
  "id": "id"
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "title": "title",
  "atomicName": "atomicName",
  "atomicScriptType": "BeforeAtomic",
  "script": "script",
  "enabled": true,
  "continueOnError": true,
  "timeout": 0,
  "order": 0
}

plain

DELETE

https://api.heart.work

/core-api/atomicscripts/{id}

path Parameters

id

string · required

Responses

No data returned

DELETE/core-api/atomicscripts/{id}

curl --request DELETE \
  --url https://api.heart.work/core-api/atomicscripts/:id

shell

Example Responses

No example specified for this content type

Apps Auth