Sign in

v1

latestOpenAPI 3.0.42026-08-064075233.0 KB
Parameters

Get parameter by id

Returns a parameter with the specified id.

get/api/parameters/{id}

Path parameters

idstring required

The identifier for the parameter that we want to get.

Response

OK

idstring nullable

The identifier of the parameter.

typestring nullable

The type of the parameter. Available values are String, Number, Boolean, Credential, Resource, Integer and Object.

organizationIdstring uuid

The identifier of the organization.

createdAtstring date-time

The time the parameter was created.

createdBystring uuid

The user that created the parameter.

updatedAtstring date-time

The time the parameter was last updated.

updatedBystring uuid

The user that last updated the parameter.

nrOfOverridesinteger

The number of overrides for the parameter.

nrOfFlowDefinitionsinteger

The number of flow definitions that uses the parameter.

Example response

{
  "id": "My parameter",
  "type": "String",
  "organizationId": "8c84e649-1669-428c-8506-47b0815180e8",
  "createdAt": "2024-09-24T09:33:38.013347Z",
  "createdBy": "256f791c-fbc0-4435-9429-d291227f6577",
  "updatedAt": "2024-09-24T09:33:38.013347Z",
  "updatedBy": "256f791c-fbc0-4435-9429-d291227f6577",
  "overrides": [
    {
      "id": "My parameter",
      "type": "String",
      "organizationId": "8c84e649-1669-428c-8506-47b0815180e8",
      "createdAt": "2024-09-24T09:33:38.013347Z",
      "createdBy": "256f791c-fbc0-4435-9429-d291227f6577",
      "updatedAt": "2024-09-24T09:33:38.013347Z",
      "updatedBy": "256f791c-fbc0-4435-9429-d291227f6577",
      "edgeNodeId": "88cd62fa-6cb1-43d3-b243-787bd6ec8041"
    }
  ],
  "nrOfOverrides": 3,
  "nrOfFlowDefinitions": 3
}