GET {repositoryId}/Identity/{id}/Lock

Locks and reads an Identity resource by ID.

Request Information

URI Parameters

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

Body Parameters

None.

Response Information

Resource Description

The requested Identity resource.

Identity

Name	Type	Additional information
Id	string	None.
RepositoryId	string	None.
ObjectType	Types	None.
PreferredLanguage	string	None.
ModelReference	NamedReference	None.
Fields	Dictionary of Object [key] and Object [value]	None.
Name	string	None.
Description	string	None.
Frozen	ChangeStatusInformation	None.
Locked	ChangeStatusInformation	None.
Created	ChangeStatusInformation	None.
LastUpdated	ChangeStatusInformation	None.
Number	string	None.
Numbered	ChangeStatusInformation	None.
AttachmentInfoList	Collection of AttachmentInfo	None.
StructureHash	string	None.
ServiceEmail	string	None.
ServiceMobilePhoneNumber	string	None.
ServiceEmailValidated	ChangeStatusInformation	None.
ServiceMobilePhoneNumberValidated	ChangeStatusInformation	None.
IdentificationCode	string	None.
IdentificationCodeExpiryDate	date	None.
IdentificationDocument	NamedReference	None.
Signature	NamedReference	None.
Picture	NamedReference	None.

Response Formats

application/json, text/json

Sample:

{
  "Name": "sample string 4",
  "Description": "sample string 5",
  "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:57:52.1964705+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:57:52.1964705+01:00"
  },
  "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:57:52.1964705+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:57:52.1964705+01:00"
  },
  "Number": "sample string 6",
  "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:57:52.1964705+01:00"
  },
  "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:57:52.1964705+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:57:52.1964705+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:57:52.1964705+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:57:52.1964705+01:00"
      },
      "Operation": 0,
      "Tags": [
        "sample string 1",
        "sample string 2"
      ],
      "Tag": "sample string 8"
    }
  ],
  "StructureHash": "sample string 7",
  "RepositoryId": "sample string 2",
  "Id": "sample string 1",
  "ObjectType": 115,
  "PreferredLanguage": "sample string 3",
  "ModelReference": {
    "Name": "sample string 1",
    "Url": "sample string 2",
    "Type": 0
  },
  "Fields": null,
  "ServiceEmail": "sample string 8",
  "ServiceMobilePhoneNumber": "sample string 9",
  "ServiceEmailValidated": {
    "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:57:52.1964705+01:00"
  },
  "ServiceMobilePhoneNumberValidated": {
    "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:57:52.1964705+01:00"
  },
  "IdentificationCode": "sample string 10",
  "IdentificationCodeExpiryDate": "2024-11-22T08:57:52.1964705+01:00",
  "IdentificationDocument": {
    "Name": "sample string 1",
    "Url": "sample string 2",
    "Type": 0
  },
  "Signature": {
    "Name": "sample string 1",
    "Url": "sample string 2",
    "Type": 0
  },
  "Picture": {
    "Name": "sample string 1",
    "Url": "sample string 2",
    "Type": 0
  }
}

application/xml, text/xml

Sample:

<Identity 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:57:52.1964705+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:57:52.1964705+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:57:52.1964705+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:57:52.1964705+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:57:52.1964705+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 5</Description>
  <Frozen>
    <Date>2024-11-22T08:57:52.1964705+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>
  <LastUpdated>
    <Date>2024-11-22T08:57:52.1964705+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:57:52.1964705+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>
  <Name>sample string 4</Name>
  <Number>sample string 6</Number>
  <Numbered>
    <Date>2024-11-22T08:57:52.1964705+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>
  <StructureHash>sample string 7</StructureHash>
  <RepositoryId>sample string 2</RepositoryId>
  <Id>sample string 1</Id>
  <ObjectType>Identity</ObjectType>
  <PreferredLanguage>sample string 3</PreferredLanguage>
  <ModelReference>
    <Type>Undefined</Type>
    <Url>sample string 2</Url>
    <Name>sample string 1</Name>
  </ModelReference>
  <Fields i:nil="true" />
  <ServiceEmail>sample string 8</ServiceEmail>
  <ServiceMobilePhoneNumber>sample string 9</ServiceMobilePhoneNumber>
  <ServiceEmailValidated>
    <Date>2024-11-22T08:57:52.1964705+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>
  </ServiceEmailValidated>
  <ServiceMobilePhoneNumberValidated>
    <Date>2024-11-22T08:57:52.1964705+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>
  </ServiceMobilePhoneNumberValidated>
  <IdentificationCode>sample string 10</IdentificationCode>
  <IdentificationCodeExpiryDate>2024-11-22T08:57:52.1964705+01:00</IdentificationCodeExpiryDate>
  <IdentificationDocument>
    <Type>Undefined</Type>
    <Url>sample string 2</Url>
    <Name>sample string 1</Name>
  </IdentificationDocument>
  <Signature>
    <Type>Undefined</Type>
    <Url>sample string 2</Url>
    <Name>sample string 1</Name>
  </Signature>
  <Picture>
    <Type>Undefined</Type>
    <Url>sample string 2</Url>
    <Name>sample string 1</Name>
  </Picture>
</Identity>