Sign in

v1

latestOpenAPI 3.0.42026-08-064075233.0 KB
Resources

Upload version data

Uploads data for the specified version of the resource with the specified id. The content must be sent as a file with multipart/form-data.

If there is a version with sizeInBytes set to 1 this request would upload the content a:

PUT /api/resources/{resourceId}/versions/{versionId}/data

Content-Type: multipart/form-data; boundary=----WebKitFormBoundaryRFAmErZ0QF6ZpyZr

------WebKitFormBoundaryRFAmErZ0QF6ZpyZr
Content-Disposition: form-data; name="file"; filename="blob"
Content-Type: text/plain

a
------WebKitFormBoundaryRFAmErZ0QF6ZpyZr--
put/api/resources/{resourceId}/versions/{versionId}/data

Path parameters

resourceIdstring uuid required

The identifier for the resource that we want to upload data for.

versionIdstring uuid required

The version of the resource that we want to upload data for.

Response

OK

idstring uuid

The identifier of the version.

resourceIdstring uuid

The identifier of the resource.

contentIdstring uuid

The identifier of the content.

namestring nullable

The name of the resource.

descriptionstring nullable

The description of the version.

typestring nullable

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

sizeInBytesinteger nullable

The size of the version in bytes.

statestring nullable

The state of the version. Available values are Draft, Completed, Archived.

pathstring nullable

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

md5Sumstring nullable

The MD5 sum of the version.

urlstring nullable

The URL of the resource.

contentTypestring nullable

The content type of the version.

versioninteger

The version of the resource.

createdAtstring date-time

The time the version was created.

createdBystring uuid

The user that created the version.

updatedAtstring date-time

The time the version was last updated.

updatedBystring uuid

The user that last updated the version.

flowsCountinteger

The number of flows that uses the version.

flowDraftsCountinteger

The number of flow drafts that uses the version.

flowTemplatesCountinteger

The number of flow templates that uses the version.

parameterValuesCountinteger

The number of parameter values that uses the version.

Example response

{
  "id": "61ec8858-abd2-455e-b023-fd1184c96329",
  "resourceId": "5189952c-21b0-4ca6-b84d-43c00fc5dad8",
  "contentId": "61ec8858-abd2-455e-b023-fd1184c96329",
  "name": "My resource",
  "description": "My description",
  "type": "File",
  "sizeInBytes": 1234,
  "state": "Draft",
  "path": "./my_path",
  "md5Sum": "1175E6103E3158432AC8EE0716B937B3",
  "contentType": "application/octet-stream",
  "version": 1,
  "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",
  "flowsCount": 3,
  "flowDraftsCount": 3,
  "flowTemplatesCount": 3,
  "parameterValuesCount": 3
}