connections.getConnectionExecution

GET

/v1/connections/{connectionId}/executions/{executionId}

const url = 'https://example.com/v1/connections/example/executions/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/v1/connections/example/executions/example \
  --header 'Authorization: Bearer <token>'

Authorizations

token
session

Parameters

Path Parameters

connectionId

required

string

>= 1 characters <= 128 characters

executionId

required

string

>= 1 characters <= 128 characters

Responses

200

Success

application/json

object

execution

required

object

required

string

>= 1 characters <= 128 characters

resource

required

object

kind

required

string

>= 1 characters <= 128 characters

required

string

>= 1 characters <= 256 characters

status

required

string

Allowed values: queued running waiting cancelling completed failed cancelled interrupted outcome_unknown

sequence

required

integer

<= 9007199254740991

createdAt

required

number

updatedAt

required

number

failure

required

Any of:

object
null

object

errorId

required

string

>= 1 characters <= 128 characters

category

required

string

Allowed values: invalid forbidden not_found conflict unavailable external outcome_unknown interrupted

result

required

Any of:

object

_tag

required

string

Allowed values: Updated

connectionId

required

string

>= 1 characters <= 128 characters

revision

required

integer

<= 9007199254740991

Example

{
  "execution": {
    "status": "queued",
    "failure": {
      "category": "invalid"
    }
  },
  "result": {
    "_tag": "Updated"
  }
}

400

ExperienceInputInvalid | OrganizationRequired

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: ExperienceInputInvalid

message

required

string

Example

{
  "_tag": "ExperienceInputInvalid"
}

401

AuthenticationRequired

application/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

AppRestricted | ExecutionForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin

application/json

Any of:

object

_tag

required

string

Allowed values: AppRestricted

restriction

required

object

cardUrl

required

string

reason

required

string

>= 1 characters

appealUrl

required

string

Example

{
  "_tag": "AppRestricted"
}

404

ExperienceNotFound | ExecutionNotFound

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: ExperienceNotFound

required

string

Example

{
  "_tag": "ExperienceNotFound"
}

409

ConnectionCleanupPending | ConnectionConflict | ExecutionConflict | ExecutionKeyConflict | @nmnmcc/ability/Authorizer/Pending

application/json

Any of:

object

_tag

required

string

Allowed values: ConnectionCleanupPending

connectionId

required

string

>= 1 characters <= 128 characters

stage

required

string

Allowed values: Credentials Connection

message

required

string

Example

{
  "_tag": "ConnectionCleanupPending",
  "stage": "Credentials"
}

422

AppDiscoveryFailed | ConnectionConfigurationInvalid

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: AppDiscoveryFailed

reason

required

string

Allowed values: InvalidInput IncompatibleCard NoDeclaration NoUsableServices Document Http BlockedTarget Transport TooLarge Timeout Redirect Encoding

issues

required

Array<object>

object

url

required

string

reason

required

string

fieldPath

string

Example

{
  "_tag": "AppDiscoveryFailed",
  "reason": "InvalidInput"
}

429

RateLimited

application/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

ExperienceStorageUnavailable | ExecutionUnavailable | AuthenticationUnavailable | RequestFailed

application/json

Any of:

object

_tag

required

string

Allowed values: ExperienceStorageUnavailable

Example

{
  "_tag": "ExperienceStorageUnavailable"
}