Workflows

Retrieve a Workflow Schema

Returns the fields used in the workflow's launch form.

OAuth Scope required: public.workflows.readSchemas

get/workflow-schemas/{id}

Request

Base URL
https://ironcladapp.com/public/api/v1
URL
https://ironcladapp.com/public/api/v1/workflow-schemas/{id}
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.readSchemas

Path parameters

idstring required

The unique identifier of a schema (see explanation of Template ID). A list of identifiers can be retrieved using the GET /workflow-schemas endpoint. Only published workflows will have an identifier.

Query parameters

formstring

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

200

idstring

namestring

permissionsstring[]

Example response

{
  "id": "6013609108b8f070cee94fc1",
  "name": "MNDA",
  "schema": {
    "counterpartyName": {
      "type": "string",
      "displayName": "Example String Attribute",
      "required": "always",
      "options": {
        "values": [
          "Option 1",
          "Option 2",
          "Option 3"
        ],
        "freeTextAllowed": true
      },
      "default": "croissant"
    },
    "amount": {
      "type": "number",
      "displayName": "Example Number Attribute",
      "required": "always",
      "options": {
        "values": [
          "Option 1",
          "Option 2",
          "Option 3"
        ],
        "freeTextAllowed": true
      },
      "default": "croissant"
    },
    "fee": {
      "type": "monetaryAmount",
      "displayName": "Example Monetary Amount Attribute",
      "required": "always",
      "options": {
        "values": [
          "Option 1",
          "Option 2",
          "Option 3"
        ],
        "freeTextAllowed": true
      },
      "default": "croissant"
    },
    "draft": {
      "type": "array",
      "elementType": {
        "type": "document",
        "displayName": "Example Document Attribute",
        "required": "always",
        "options": {
          "values": [
            "Option 1",
            "Option 2",
            "Option 3"
          ],
          "freeTextAllowed": true
        },
        "default": "croissant"
      }
    },
    "lineItems": {
      "type": "array",
      "elementType": {
        "type": "object",
        "displayName": "Example Object Attribute",
        "required": "always",
        "options": {
          "values": [
            "Option 1",
            "Option 2",
            "Option 3"
          ],
          "freeTextAllowed": true
        },
        "default": "croissant",
        "schema": {
          "childAttribute": {
            "type": "string",
            "displayName": "Example String Attribute",
            "required": "always",
            "options": {
              "values": [
                "Option 1",
                "Option 2",
                "Option 3"
              ],
              "freeTextAllowed": true
            },
            "default": "croissant"
          },
          "anotherChildAttribute": {
            "type": "string",
            "displayName": "Example String Attribute",
            "required": "always",
            "options": {
              "values": [
                "Option 1",
                "Option 2",
                "Option 3"
              ],
              "freeTextAllowed": true
            },
            "default": "croissant"
          }
        }
      }
    },
    "exampleLinkedRecord": {
      "type": "linkedRecord",
      "displayName": "Example Linked Record",
      "required": "always",
      "schema": {
        "properties": {
          "type": "object",
          "displayName": "properties",
          "schema": {}
        }
      }
    },
    "exampleParentRecord": {
      "type": "parentRecord",
      "displayName": "Example Parent Record",
      "required": "always",
      "schema": {
        "properties": {
          "type": "object",
          "displayName": "properties",
          "schema": {}
        }
      }
    },
    "exampleChildRecord": {
      "type": "childRecord",
      "displayName": "Example Child Record",
      "required": "always",
      "schema": {
        "properties": {
          "type": "object",
          "displayName": "properties",
          "schema": {}
        }
      }
    }
  },
  "permissions": [
    "launch",
    "view"
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.