Sign in

v1

latestOpenAPI 3.0.42026-08-064075233.0 KB
Resources

Get resource by id

Returns a resource with the specified id.

get/api/resources/{resourceId}

Path parameters

resourceIdstring uuid required

The identifier for the resource that we want to get.

Response

OK

idstring uuid

The identifier of the resource.

organizationIdstring uuid

The identifier of the organization.

namestring nullable

The name of the resource.

typestring nullable

The type of the resource. Available values are File, CSharpScript, PythonScript, Modbus, OPC, SiemensS7, Rockwell, PiWebApi, DataTriggerDefinitions, AvevaHistorian.

pathOnNodestring nullable

Optional. The path of the resource. Some type of resources have no path, such as Modbus.

currentVersioninteger

The latest version of the resource (including archived).

currentActiveVersioninteger

The latest active version of the resource (not inlcuding archived).

categorystring nullable

The category of the resource.

hasDraftboolean

Whether the resource has a draft version.

flowsCountinteger

The number of flows that uses the resource.

flowDraftsCountinteger

The number of flow drafts that uses the resource.

flowTemplatesCountinteger

The number of flow templates that uses the resource.

parameterValuesCountinteger

The number of parameter values that uses the resource.

createdAtstring date-time

The time the resource was created.

createdBystring uuid

The user that created the resource.

updatedAtstring date-time

The time the resource was last updated.

updatedBystring uuid

The user that last updated the resource.

pathstring nullable

Example response

{
  "id": "5189952c-21b0-4ca6-b84d-43c00fc5dad8",
  "organizationId": "8c84e649-1669-428c-8506-47b0815180e8",
  "name": "My resource",
  "type": "File",
  "pathOnNode": "./my_path",
  "currentVersion": 1,
  "currentActiveVersion": 1,
  "category": "My category",
  "hasDraft": true,
  "flowsCount": 3,
  "flowDraftsCount": 3,
  "flowTemplatesCount": 3,
  "parameterValuesCount": 3,
  "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"
}