IRironcladapp
Workflows

Retrieve the Status of an Async Workflow Create Job

Changed on

Check the status of a Workflow you created while using the Create a Workflow Async route.

OAuth Scope required: public.workflows.createWorkflows

get/workflows/async/{asyncJobId}

Request

  • Base URL
    https://ironcladapp.com/public/api/v1
  • URL
    https://ironcladapp.com/public/api/v1/workflows/async/{asyncJobId}
  • Auth
    API key in header Authorization and OAuth 2
    Authorization code: https://ironcladapp.com/oauth/authorize
    Client credentials
    Token URL: https://ironcladapp.com/oauth/token scopes: public.workflows.createWorkflows

Path parameters

asyncJobIdstring required

The identifier provided in the response of creating a Workflow asynchronously.

Headers

x-as-user-emailstring
Example:jane.doe@test.com

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-id is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. A token produced from the Authorization Code grant (which is already scoped to a user) may also use this header to act as a different user in the same company, provided the token carries the identity.users.impersonate scope and the token's own user has been granted the API User Impersonation permission. A request that sends this header without both never acts as the named user; depending on the company's configuration it either proceeds as the token's own user or is rejected with a 403. More information about permissions.

x-as-user-idstring
Example:5f0375c4cdc1927a3c5edcd3

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-email is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. A token produced from the Authorization Code grant (which is already scoped to a user) may also use this header to act as a different user in the same company, provided the token carries the identity.users.impersonate scope and the token's own user has been granted the API User Impersonation permission. A request that sends this header without both never acts as the named user; depending on the company's configuration it either proceeds as the token's own user or is rejected with a 403. More information about permissions.

Response

The status of the workflow launch.

OR
OR

Example response

{
  "requestPayload": {
    "template": "600b296c3e15a234ab88f884",
    "attributes": {
      "counterpartyName": "Example Company",
      "draft": [
        {
          "url": "https://www.law.berkeley.edu/wp-content/uploads/2018/12/Resume-Samples-1.pdf"
        }
      ],
      "localLinkedRecord": "IC-123",
      "localParentRecord": "IC-456",
      "localChildRecord": "IC-789"
    }
  },
  "workflowUrls": {
    "browserUrl": "https://ironcladapp.com/workflows/6013609108b8f070cee94fc1",
    "apiUrl": "https://ironcladapp.com/public/api/v1/workflows/6013609108b8f070cee94fc1"
  },
  "workflow": {
    "id": "6013609108b8f070cee94fc1",
    "ironcladId": "IC-1",
    "title": "Consulting Agreement with Jane Doe",
    "template": "600b296c3e15a234ab88f884",
    "step": "Review",
    "schema": {
      "counterpartyName": "Example Company",
      "draft": [
        {
          "url": "https://www.law.berkeley.edu/wp-content/uploads/2018/12/Resume-Samples-1.pdf"
        }
      ],
      "localLinkedRecord": "IC-123",
      "localParentRecord": "IC-456",
      "localChildRecord": "IC-789"
    },
    "status": "active",
    "creator": {
      "id": "63d415e0dd0d828c3a878548",
      "email": "fett@intergalactic.com",
      "displayName": "Boba Fett"
    },
    "created": "2016-11-17T00:37:22.318Z",
    "lastUpdated": "2016-11-17T00:37:42.318Z",
    "roles": [
      {
        "id": "legal",
        "displayName": "Legal",
        "assignees": [
          {
            "userName": "Boba Fett",
            "userId": "63d415e0dd0d828c3a878548",
            "email": "bobafett@example.com"
          }
        ]
      }
    ],
    "approvals": {
      "state": "in_progress"
    },
    "signatures": {
      "state": "in_progress",
      "url": "https://ironcladapp.com/public/api/v1/workflows/6dac47a10b1242d1f7df688d/signatures"
    },
    "recordIds": [
      "715f1e37-292f-4e6c-8b48-c07e1b68bccd"
    ]
  }
}

Changes

  • 435da5a4396eRevision changes
    • warning

      removed the optional property ///// from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added the optional property // to the response with the status