GET {repositoryId}/Data/{id}/Lock

Locks and reads a Data resource by ID.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The ID of the Data resource.	string	Required
repositoryId	ID of the resource repository (optional).	string	Default value is

Body Parameters

None.

Response Information

Resource Description

The requested Data resource.

Data

Name	Type	Additional information
Created	ChangeStatusInformation	None.
LastUpdated	ChangeStatusInformation	None.
Locked	ChangeStatusInformation	None.
Frozen	ChangeStatusInformation	None.
Name	string	None.
Description	string	None.
Id	string	None.
RepositoryId	string	None.
Number	string	None.
Numbered	ChangeStatusInformation	None.
ModelReference	NamedReference	None.
Fields	Dictionary of Object [key] and Object [value]	None.
AttachmentInfoList	Collection of AttachmentInfo	None.
SendingStatus	SendingStatus	None.
SendingProgress	decimal number	None.
SendingDirection	SendingDirection	None.
StructureHash	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Created": {
    "IdentityReference": {
      "Name": "sample string 1",
      "Url": "sample string 2",
      "Type": 0
    },
    "PositionReference": {
      "Name": "sample string 1",
      "Url": "sample string 2",
      "Type": 0
    },
    "Date": "2024-11-22T08:24:16.9275614+01:00"
  },
  "LastUpdated": {
    "IdentityReference": {
      "Name": "sample string 1",
      "Url": "sample string 2",
      "Type": 0
    },
    "PositionReference": {
      "Name": "sample string 1",
      "Url": "sample string 2",
      "Type": 0
    },
    "Date": "2024-11-22T08:24:16.9275614+01:00"
  },
  "Locked": {
    "IdentityReference": {
      "Name": "sample string 1",
      "Url": "sample string 2",
      "Type": 0
    },
    "PositionReference": {
      "Name": "sample string 1",
      "Url": "sample string 2",
      "Type": 0
    },
    "Date": "2024-11-22T08:24:16.9275614+01:00"
  },
  "Frozen": {
    "IdentityReference": {
      "Name": "sample string 1",
      "Url": "sample string 2",
      "Type": 0
    },
    "PositionReference": {
      "Name": "sample string 1",
      "Url": "sample string 2",
      "Type": 0
    },
    "Date": "2024-11-22T08:24:16.9275614+01:00"
  },
  "Name": "sample string 1",
  "Description": "sample string 2",
  "Id": "sample string 3",
  "RepositoryId": "sample string 4",
  "Number": "sample string 5",
  "Numbered": {
    "IdentityReference": {
      "Name": "sample string 1",
      "Url": "sample string 2",
      "Type": 0
    },
    "PositionReference": {
      "Name": "sample string 1",
      "Url": "sample string 2",
      "Type": 0
    },
    "Date": "2024-11-22T08:24:16.9275614+01:00"
  },
  "ModelReference": {
    "Name": "sample string 1",
    "Url": "sample string 2",
    "Type": 0
  },
  "Fields": null,
  "AttachmentInfoList": [
    {
      "RepositoryId": "sample string 1",
      "Id": "sample string 2",
      "OwnerType": 0,
      "AttachmentId": "sample string 3",
      "FileName": "sample string 4",
      "FileExtension": "sample string 5",
      "FileLength": 6,
      "System": true,
      "Created": {
        "IdentityReference": {
          "Name": "sample string 1",
          "Url": "sample string 2",
          "Type": 0
        },
        "PositionReference": {
          "Name": "sample string 1",
          "Url": "sample string 2",
          "Type": 0
        },
        "Date": "2024-11-22T08:24:16.9275614+01:00"
      },
      "LastUpdated": {
        "IdentityReference": {
          "Name": "sample string 1",
          "Url": "sample string 2",
          "Type": 0
        },
        "PositionReference": {
          "Name": "sample string 1",
          "Url": "sample string 2",
          "Type": 0
        },
        "Date": "2024-11-22T08:24:16.9275614+01:00"
      },
      "Operation": 0,
      "Tags": [
        "sample string 1",
        "sample string 2"
      ],
      "Tag": "sample string 8"
    },
    {
      "RepositoryId": "sample string 1",
      "Id": "sample string 2",
      "OwnerType": 0,
      "AttachmentId": "sample string 3",
      "FileName": "sample string 4",
      "FileExtension": "sample string 5",
      "FileLength": 6,
      "System": true,
      "Created": {
        "IdentityReference": {
          "Name": "sample string 1",
          "Url": "sample string 2",
          "Type": 0
        },
        "PositionReference": {
          "Name": "sample string 1",
          "Url": "sample string 2",
          "Type": 0
        },
        "Date": "2024-11-22T08:24:16.9275614+01:00"
      },
      "LastUpdated": {
        "IdentityReference": {
          "Name": "sample string 1",
          "Url": "sample string 2",
          "Type": 0
        },
        "PositionReference": {
          "Name": "sample string 1",
          "Url": "sample string 2",
          "Type": 0
        },
        "Date": "2024-11-22T08:24:16.9275614+01:00"
      },
      "Operation": 0,
      "Tags": [
        "sample string 1",
        "sample string 2"
      ],
      "Tag": "sample string 8"
    }
  ],
  "SendingStatus": 0,
  "SendingProgress": 6.1,
  "SendingDirection": 0,
  "StructureHash": "sample string 7"
}

application/xml, text/xml

Sample:

<Data xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.openworkbpm.com/schema">
  <AttachmentInfoList>
    <AttachmentInfo>
      <AttachmentId>sample string 3</AttachmentId>
      <Created>
        <Date>2024-11-22T08:24:16.9275614+01:00</Date>
        <IdentityReference>
          <Type>Undefined</Type>
          <Url>sample string 2</Url>
          <Name>sample string 1</Name>
        </IdentityReference>
        <PositionReference>
          <Type>Undefined</Type>
          <Url>sample string 2</Url>
          <Name>sample string 1</Name>
        </PositionReference>
      </Created>
      <FileExtension>sample string 5</FileExtension>
      <FileLength>6</FileLength>
      <FileName>sample string 4</FileName>
      <Id>sample string 2</Id>
      <LastUpdated>
        <Date>2024-11-22T08:24:16.9275614+01:00</Date>
        <IdentityReference>
          <Type>Undefined</Type>
          <Url>sample string 2</Url>
          <Name>sample string 1</Name>
        </IdentityReference>
        <PositionReference>
          <Type>Undefined</Type>
          <Url>sample string 2</Url>
          <Name>sample string 1</Name>
        </PositionReference>
      </LastUpdated>
      <Operation>None</Operation>
      <OwnerType>Undefined</OwnerType>
      <RepositoryId>sample string 1</RepositoryId>
      <System>true</System>
      <Tags xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Tags>
      <Tag>sample string 8</Tag>
    </AttachmentInfo>
    <AttachmentInfo>
      <AttachmentId>sample string 3</AttachmentId>
      <Created>
        <Date>2024-11-22T08:24:16.9275614+01:00</Date>
        <IdentityReference>
          <Type>Undefined</Type>
          <Url>sample string 2</Url>
          <Name>sample string 1</Name>
        </IdentityReference>
        <PositionReference>
          <Type>Undefined</Type>
          <Url>sample string 2</Url>
          <Name>sample string 1</Name>
        </PositionReference>
      </Created>
      <FileExtension>sample string 5</FileExtension>
      <FileLength>6</FileLength>
      <FileName>sample string 4</FileName>
      <Id>sample string 2</Id>
      <LastUpdated>
        <Date>2024-11-22T08:24:16.9275614+01:00</Date>
        <IdentityReference>
          <Type>Undefined</Type>
          <Url>sample string 2</Url>
          <Name>sample string 1</Name>
        </IdentityReference>
        <PositionReference>
          <Type>Undefined</Type>
          <Url>sample string 2</Url>
          <Name>sample string 1</Name>
        </PositionReference>
      </LastUpdated>
      <Operation>None</Operation>
      <OwnerType>Undefined</OwnerType>
      <RepositoryId>sample string 1</RepositoryId>
      <System>true</System>
      <Tags xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Tags>
      <Tag>sample string 8</Tag>
    </AttachmentInfo>
  </AttachmentInfoList>
  <Created>
    <Date>2024-11-22T08:24:16.9275614+01:00</Date>
    <IdentityReference>
      <Type>Undefined</Type>
      <Url>sample string 2</Url>
      <Name>sample string 1</Name>
    </IdentityReference>
    <PositionReference>
      <Type>Undefined</Type>
      <Url>sample string 2</Url>
      <Name>sample string 1</Name>
    </PositionReference>
  </Created>
  <Description>sample string 2</Description>
  <Fields i:nil="true" />
  <Frozen>
    <Date>2024-11-22T08:24:16.9275614+01:00</Date>
    <IdentityReference>
      <Type>Undefined</Type>
      <Url>sample string 2</Url>
      <Name>sample string 1</Name>
    </IdentityReference>
    <PositionReference>
      <Type>Undefined</Type>
      <Url>sample string 2</Url>
      <Name>sample string 1</Name>
    </PositionReference>
  </Frozen>
  <Id>sample string 3</Id>
  <LastUpdated>
    <Date>2024-11-22T08:24:16.9275614+01:00</Date>
    <IdentityReference>
      <Type>Undefined</Type>
      <Url>sample string 2</Url>
      <Name>sample string 1</Name>
    </IdentityReference>
    <PositionReference>
      <Type>Undefined</Type>
      <Url>sample string 2</Url>
      <Name>sample string 1</Name>
    </PositionReference>
  </LastUpdated>
  <Locked>
    <Date>2024-11-22T08:24:16.9275614+01:00</Date>
    <IdentityReference>
      <Type>Undefined</Type>
      <Url>sample string 2</Url>
      <Name>sample string 1</Name>
    </IdentityReference>
    <PositionReference>
      <Type>Undefined</Type>
      <Url>sample string 2</Url>
      <Name>sample string 1</Name>
    </PositionReference>
  </Locked>
  <ModelReference>
    <Type>Undefined</Type>
    <Url>sample string 2</Url>
    <Name>sample string 1</Name>
  </ModelReference>
  <Name>sample string 1</Name>
  <Number>sample string 5</Number>
  <Numbered>
    <Date>2024-11-22T08:24:16.9275614+01:00</Date>
    <IdentityReference>
      <Type>Undefined</Type>
      <Url>sample string 2</Url>
      <Name>sample string 1</Name>
    </IdentityReference>
    <PositionReference>
      <Type>Undefined</Type>
      <Url>sample string 2</Url>
      <Name>sample string 1</Name>
    </PositionReference>
  </Numbered>
  <RepositoryId>sample string 4</RepositoryId>
  <SendingDirection>None</SendingDirection>
  <SendingProgress>6.1</SendingProgress>
  <SendingStatus>None</SendingStatus>
  <StructureHash>sample string 7</StructureHash>
</Data>