Zum Inhalt springen
AcrivaDocs

CheckScript

POST
/api/v1/t/{tenant}/workflows/scripts/check
curl --request POST \
  --url https://example.com/api/v1/t/example/workflows/scripts/check \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "source": "example", "sdkVersion": "example", "hook": "OnDocumentArrived", "definitionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "stepName": "example" }'

Authorizations

Abschnitt betitelt „Authorizations“

Parameters

Abschnitt betitelt „ Parameters “

Path Parameters

Abschnitt betitelt „Path Parameters“
tenant
required
string

Tenant slug

Request Bodyrequired

Abschnitt betitelt „Request Bodyrequired“
Media typeapplication/json
object
source
required
string
sdkVersion
required
string
hook
required
One of:
null
definitionId
null | string format: uuid
stepName
null | string

Responses

Abschnitt betitelt „ Responses “

200

Abschnitt betitelt „200“

OK

Media typeapplication/json
object
diagnostics
required
Array<object>
object
code
required
string
severity
required
Allowed values: Error Warning
message
required
string
line
required
integer format: int32
column
required
integer format: int32
endLine
required
integer format: int32
endColumn
required
integer format: int32
Example
{
  "diagnostics": [
    {
      "severity": "Error"
    }
  ]
}

400

Abschnitt betitelt „400“

Bad Request

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
errors
object
key
additional properties
Array<string>
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

403

Abschnitt betitelt „403“

Forbidden

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Abschnitt betitelt „404“

Not Found

413

Abschnitt betitelt „413“

Payload Too Large

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

415

Abschnitt betitelt „415“

Unsupported Media Type

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

429

Abschnitt betitelt „429“

Too Many Requests

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

503

Abschnitt betitelt „503“

Service Unavailable

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}