Sets an execution to call a target or include the targets of another execution.

PUT 
/resources/v3alpha/actions/executions

Setting an empty list of targets will remove all targets from the execution, making it a noop.

Request

application/json

Body

required

instance

object

id string

domain string

condition

object

request

object

Condition-type to execute if a request on the defined API point happens.

method string

Possible values: non-empty and <= 1000 characters

GRPC-method as condition.

service string

Possible values: non-empty and <= 1000 characters

GRPC-service as condition.

all boolean

All calls to any available services and methods as condition.

response

object

Condition-type to execute on response if a request on the defined API point happens.

method string

Possible values: non-empty and <= 1000 characters

GRPC-method as condition.

service string

Possible values: non-empty and <= 1000 characters

GRPC-service as condition.

all boolean

All calls to any available services and methods as condition.

function

object

Condition-type to execute if function is used, replaces actions v1.

name string

event

object

Condition-type to execute if an event is created in the system.

event string

Possible values: non-empty and <= 1000 characters

Event name as condition.

group string

Possible values: non-empty and <= 1000 characters

Event group as condition, all events under this group.

all boolean

all events as condition.

execution

object

targets

object[]

Ordered list of targets/includes called during the execution.

Array [

target string

Unique identifier of existing target to call.

include

object

Unique identifier of existing execution to include targets of.

request

object

Condition-type to execute if a request on the defined API point happens.

method string

Possible values: non-empty and <= 1000 characters

GRPC-method as condition.

service string

Possible values: non-empty and <= 1000 characters

GRPC-service as condition.

all boolean

All calls to any available services and methods as condition.

response

object

Condition-type to execute on response if a request on the defined API point happens.

method string

Possible values: non-empty and <= 1000 characters

GRPC-method as condition.

service string

Possible values: non-empty and <= 1000 characters

GRPC-service as condition.

all boolean

All calls to any available services and methods as condition.

function

object

Condition-type to execute if function is used, replaces actions v1.

name string

event

object

Condition-type to execute if an event is created in the system.

event string

Possible values: non-empty and <= 1000 characters

Event name as condition.

group string

Possible values: non-empty and <= 1000 characters

Event group as condition, all events under this group.

all boolean

all events as condition.

]

application/grpc

Body

required

instance

object

id string

domain string

condition

object

request

object

Condition-type to execute if a request on the defined API point happens.

method string

Possible values: non-empty and <= 1000 characters

GRPC-method as condition.

service string

Possible values: non-empty and <= 1000 characters

GRPC-service as condition.

all boolean

All calls to any available services and methods as condition.

response

object

Condition-type to execute on response if a request on the defined API point happens.

method string

Possible values: non-empty and <= 1000 characters

GRPC-method as condition.

service string

Possible values: non-empty and <= 1000 characters

GRPC-service as condition.

all boolean

All calls to any available services and methods as condition.

function

object

Condition-type to execute if function is used, replaces actions v1.

name string

event

object

Condition-type to execute if an event is created in the system.

event string

Possible values: non-empty and <= 1000 characters

Event name as condition.

group string

Possible values: non-empty and <= 1000 characters

Event group as condition, all events under this group.

all boolean

all events as condition.

execution

object

targets

object[]

Ordered list of targets/includes called during the execution.

Array [

target string

Unique identifier of existing target to call.

include

object

Unique identifier of existing execution to include targets of.

request

object

Condition-type to execute if a request on the defined API point happens.

method string

Possible values: non-empty and <= 1000 characters

GRPC-method as condition.

service string

Possible values: non-empty and <= 1000 characters

GRPC-service as condition.

all boolean

All calls to any available services and methods as condition.

response

object

Condition-type to execute on response if a request on the defined API point happens.

method string

Possible values: non-empty and <= 1000 characters

GRPC-method as condition.

service string

Possible values: non-empty and <= 1000 characters

GRPC-service as condition.

all boolean

All calls to any available services and methods as condition.

function

object

Condition-type to execute if function is used, replaces actions v1.

name string

event

object

Condition-type to execute if an event is created in the system.

event string

Possible values: non-empty and <= 1000 characters

Event name as condition.

group string

Possible values: non-empty and <= 1000 characters

Event group as condition, all events under this group.

all boolean

all events as condition.

]

application/grpc-web+proto

Body

required

instance

object

id string

domain string

condition

object

request

object

Condition-type to execute if a request on the defined API point happens.

method string

Possible values: non-empty and <= 1000 characters

GRPC-method as condition.

service string

Possible values: non-empty and <= 1000 characters

GRPC-service as condition.

all boolean

All calls to any available services and methods as condition.

response

object

Condition-type to execute on response if a request on the defined API point happens.

method string

Possible values: non-empty and <= 1000 characters

GRPC-method as condition.

service string

Possible values: non-empty and <= 1000 characters

GRPC-service as condition.

all boolean

All calls to any available services and methods as condition.

function

object

Condition-type to execute if function is used, replaces actions v1.

name string

event

object

Condition-type to execute if an event is created in the system.

event string

Possible values: non-empty and <= 1000 characters

Event name as condition.

group string

Possible values: non-empty and <= 1000 characters

Event group as condition, all events under this group.

all boolean

all events as condition.

execution

object

targets

object[]

Ordered list of targets/includes called during the execution.

Array [

target string

Unique identifier of existing target to call.

include

object

Unique identifier of existing execution to include targets of.

request

object

Condition-type to execute if a request on the defined API point happens.

method string

Possible values: non-empty and <= 1000 characters

GRPC-method as condition.

service string

Possible values: non-empty and <= 1000 characters

GRPC-service as condition.

all boolean

All calls to any available services and methods as condition.

response

object

Condition-type to execute on response if a request on the defined API point happens.

method string

Possible values: non-empty and <= 1000 characters

GRPC-method as condition.

service string

Possible values: non-empty and <= 1000 characters

GRPC-service as condition.

all boolean

All calls to any available services and methods as condition.

function

object

Condition-type to execute if function is used, replaces actions v1.

name string

event

object

Condition-type to execute if an event is created in the system.

event string

Possible values: non-empty and <= 1000 characters

Event name as condition.

group string

Possible values: non-empty and <= 1000 characters

Event group as condition, all events under this group.

all boolean

all events as condition.

]

Responses

200

Execution successfully updated or left unchanged

application/json

Schema

Schema

details

object

id string

created date-time

the timestamp of the first event applied to the object.

changed date-time

the timestamp of the last event applied to the object.

owner

object

the parent object representing the returned objects context.

type string

Possible values: [OWNER_TYPE_UNSPECIFIED, OWNER_TYPE_SYSTEM, OWNER_TYPE_INSTANCE, OWNER_TYPE_ORG]

Default value: OWNER_TYPE_UNSPECIFIED

id string

Example (from schema)

{
  "details": {
    "id": "69629012906488334",
    "created": "2024-09-19T14:29:22.999Z",
    "changed": "2024-09-19T14:29:22.999Z",
    "owner": "69629023906488334"
  }
}

application/grpc

Schema

Schema

details

object

id string

created date-time

the timestamp of the first event applied to the object.

changed date-time

the timestamp of the last event applied to the object.

owner

object

the parent object representing the returned objects context.

type string

Possible values: [OWNER_TYPE_UNSPECIFIED, OWNER_TYPE_SYSTEM, OWNER_TYPE_INSTANCE, OWNER_TYPE_ORG]

Default value: OWNER_TYPE_UNSPECIFIED

id string

Example (from schema)

{
  "details": {
    "id": "69629012906488334",
    "created": "2024-09-19T14:29:22.999Z",
    "changed": "2024-09-19T14:29:22.999Z",
    "owner": "69629023906488334"
  }
}

application/grpc-web+proto

Schema

Schema

details

object

id string

created date-time

the timestamp of the first event applied to the object.

changed date-time

the timestamp of the last event applied to the object.

owner

object

the parent object representing the returned objects context.

type string

Possible values: [OWNER_TYPE_UNSPECIFIED, OWNER_TYPE_SYSTEM, OWNER_TYPE_INSTANCE, OWNER_TYPE_ORG]

Default value: OWNER_TYPE_UNSPECIFIED

id string

Example (from schema)

{
  "details": {
    "id": "69629012906488334",
    "created": "2024-09-19T14:29:22.999Z",
    "changed": "2024-09-19T14:29:22.999Z",
    "owner": "69629023906488334"
  }
}

403

Returned when the user does not have permission to access the resource.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

404

Returned when the resource does not exist.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...