Workflow Variable

Create Workflow Variable

Endpoint to create a new Workflow Variable

post/workflow-variable

Request

Request body

Example request

{
  "data": {
    "projectId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "name": "Example Text"
  }
}

Response

Created successfully

Example response

{
  "data": {
    "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "createdAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "updatedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "deletedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "project": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "projectId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "workflow": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "workflowId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "name": "Example Text",
    "description": "This is an example of longer text content that provides detailed information.",
    "isSecret": true,
    "variableType": "Example Text",
    "oauthGrantType": "Example Text",
    "oauthTokenUrl": "https://example.com",
    "oauthClientId": "This is an example of longer text content that provides detailed information.",
    "oauthScope": "This is an example of longer text content that provides detailed information.",
    "oauthAdditionalParameters": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "oauthClientAuthenticationMethod": "Example Text",
    "oauthAccessTokenExpiresAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "oauthLastRefreshedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "oauthLastRefreshError": "This is an example of longer text content that provides detailed information.",
    "oauthLastRefreshErrorAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "createdByUser": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "createdByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "deletedByUser": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "deletedByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.