GET CustomEntities/{id}

Get the definition of an exising Custom Entity by the system ID


Parameters

NameDescriptionAdditional information
id 
The system ID of the Custom Entity

Define this parameter in the request URI.

Response body formats

An instance of

application/json, text/json

Sample: 
{
  "Item": {
    "Fields": [
      {
        "Attribute": {
          "Description": "sample string 1",
          "DisplayName": "sample string 2",
          "FieldId": "d234b17c-6204-4c5c-8d7e-f360a29eea51",
          "Id": 4,
          "Tooltip": "sample string 5",
          "Type": 0,
          "Format": 0
        },
        "Column": 64,
        "Row": 64,
        "LabelText": "sample string 3"
      },
      {
        "Attribute": {
          "Description": "sample string 1",
          "DisplayName": "sample string 2",
          "FieldId": "d234b17c-6204-4c5c-8d7e-f360a29eea51",
          "Id": 4,
          "Tooltip": "sample string 5",
          "Type": 0,
          "Format": 0
        },
        "Column": 64,
        "Row": 64,
        "LabelText": "sample string 3"
      },
      {
        "Attribute": {
          "Description": "sample string 1",
          "DisplayName": "sample string 2",
          "FieldId": "d234b17c-6204-4c5c-8d7e-f360a29eea51",
          "Id": 4,
          "Tooltip": "sample string 5",
          "Type": 0,
          "Format": 0
        },
        "Column": 64,
        "Row": 64,
        "LabelText": "sample string 3"
      }
    ],
    "Id": 1
  },
  "ResponseInformation": {
    "Errors": [
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      },
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      },
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      }
    ],
    "Status": 0,
    "Links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      }
    ]
  }
}

application/xml, text/xml

Sample: 
<CustomEntityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Responses">
  <ResponseInformation xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Common">
    <Errors>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
    </Errors>
    <Links>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
    </Links>
    <Status>Failure</Status>
  </ResponseInformation>
  <Item xmlns:d2p1="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Types" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Common">
    <d2p1:Fields>
      <d2p1:CustomEntityFormField>
        <d2p1:Attribute>
          <d2p1:Description>sample string 1</d2p1:Description>
          <d2p1:DisplayName>sample string 2</d2p1:DisplayName>
          <d2p1:FieldId>d234b17c-6204-4c5c-8d7e-f360a29eea51</d2p1:FieldId>
          <d2p1:Format>NotSet</d2p1:Format>
          <d2p1:Id>4</d2p1:Id>
          <d2p1:Tooltip>sample string 5</d2p1:Tooltip>
          <d2p1:Type>NotSet</d2p1:Type>
        </d2p1:Attribute>
        <d2p1:Column>64</d2p1:Column>
        <d2p1:LabelText>sample string 3</d2p1:LabelText>
        <d2p1:Row>64</d2p1:Row>
      </d2p1:CustomEntityFormField>
      <d2p1:CustomEntityFormField>
        <d2p1:Attribute>
          <d2p1:Description>sample string 1</d2p1:Description>
          <d2p1:DisplayName>sample string 2</d2p1:DisplayName>
          <d2p1:FieldId>d234b17c-6204-4c5c-8d7e-f360a29eea51</d2p1:FieldId>
          <d2p1:Format>NotSet</d2p1:Format>
          <d2p1:Id>4</d2p1:Id>
          <d2p1:Tooltip>sample string 5</d2p1:Tooltip>
          <d2p1:Type>NotSet</d2p1:Type>
        </d2p1:Attribute>
        <d2p1:Column>64</d2p1:Column>
        <d2p1:LabelText>sample string 3</d2p1:LabelText>
        <d2p1:Row>64</d2p1:Row>
      </d2p1:CustomEntityFormField>
      <d2p1:CustomEntityFormField>
        <d2p1:Attribute>
          <d2p1:Description>sample string 1</d2p1:Description>
          <d2p1:DisplayName>sample string 2</d2p1:DisplayName>
          <d2p1:FieldId>d234b17c-6204-4c5c-8d7e-f360a29eea51</d2p1:FieldId>
          <d2p1:Format>NotSet</d2p1:Format>
          <d2p1:Id>4</d2p1:Id>
          <d2p1:Tooltip>sample string 5</d2p1:Tooltip>
          <d2p1:Type>NotSet</d2p1:Type>
        </d2p1:Attribute>
        <d2p1:Column>64</d2p1:Column>
        <d2p1:LabelText>sample string 3</d2p1:LabelText>
        <d2p1:Row>64</d2p1:Row>
      </d2p1:CustomEntityFormField>
    </d2p1:Fields>
    <d2p1:Id>1</d2p1:Id>
  </Item>
</CustomEntityResponse>
URI parameters
=
Headers | Add header
: Delete
Body
Samples:
Status
Headers
Body