Change or remove an asset's representatives

Update

Call template

POST or GET/API/DataTable/V2.2/Documents.{asset-type}.{asset-subtype}:Update?Corefield.{identifying-metadata-field}={asset-identifier}&CoreField.Representative_DO:=[DataTable/v2.2/Documents.{asset-type}.{asset-subtype}:Read?CoreField.{identifying-metadata-field}={asset-identifier}]

ℹ️
Note
Many of the calls to update an asset’s representatives include a sub-call. The sub-call is enclosed in square brackets.
For example, consider the following call:
/API/DataTable/v2.2/Documents.Folder.Event-Folder:Update?CoreField.Identifier=ZZ13VPB&CoreField.Representative_DO:=[DataTable/v2.2/Documents.Image.Production-Still:Read?CoreField.Identifier=ZZ17HB]
In this call, the sub-call is:DataTable/v2.2/Documents.Image.Production-Still:Read?CoreField.Identifier=ZZ17HB
The sub-call locates the Production Still with the unique identifier ZZ17HB. You can adjust this sub-call to locate a different type of image, such as Standard Image.

Example 1: Change an asset’s representative image

Update the representative of the Event Folder with the Unique ID ZZ13VPB to the Production Still with the Unique ID ZZ17HB.

POST or GET/API/DataTable/v2.2/Documents.Folder.Event-Folder:Update?CoreField.Identifier=ZZ13VPB&CoreField.Representative_DO:=[DataTable/v2.2/Documents.Image.Production-Still:Read?CoreField.Identifier=ZZ17HB]

Call

  
curl --location --globoff --request POST 'https://mangovations.com/API/DataTable/v2.2/Documents.Folder.Event-Folder:Update?CoreField.Identifier=ZZ13VPB&CoreField.Representative_DO%3A=[DataTable%2Fv2.2%2FDocuments.Image.Production-Still%3ARead%3FCoreField.Identifier%3DZZ17HB]' \
--header 'Authorization: Bearer ItoG3WCisbIMNsbRKTC9Ur@BEtlCSn2CCGT@nPhKIVylij.Vw6pAVt8FyDpE4l6SfOe3fYHVUZgz3WSR5ZyTvkz1l57MWwAjCAE3YKonccQxCG70Q' \
--header 'Cookie: AWSALB=vAyMQk0oINZ1e6LxvIZ7aVxP+1Thfy2uX9xlPKGd6dXOzzH6hcOnR1DjYXKv3BbbZ4DOV1nZFl2zvu0k4IVc/5kPphl3MqZsGROygfcicoAi; AWSALBCORS=vAyMQk0oINZ1e6LxvIoRG6DfNOHMEDHfNrZ7aVxP+1Thfy2uX9xlPKGd6dXOzzH6hcOnR1DjYXKv3BbbZ4DOV1nZFl2zvu0k4IVc/5kPphl3MqZsGROygfcicoAi; AWSALBTG=GIr9/S1pblNRVoRJjBjzUNEQY0WtD+Pm8zSCZWXxAAnvJ2uKuv4jqOJZIKr7O1LXHmYhDMSpsNUQuBGTvqy3NqgQaT0jGvpgJZphbj+J7tBHF6oPPobtzjBNveX3AeQwdl/tm5HbxrNEgAyAE9GC6jHK9LpmG; AWSALBTGCORS=GIr9/S1pblNRVoRJjBjzUNEQY0WtD+Pm8zSCZWXxAAZ7xQ33jKuv4jqOJZIKr7O1LXHmYhDMSpsNUQuBGTvqy3NqgQaT0jGvpgJZphbj+J7tBHF6oPPobtzjBNveX3AeQwdl/tm5HbxrNEgAyAE9GC6jHK9LpmG; 
CortexCID_ZZ1=iu5G2rhGj5; ZZ1-Session__1505=CfDJ8KSkO661hSREsDx7PGb48%2B0fOXlRvUezw9rF3TSehLuHqXnOE0LYrXcLNAaeyRbbHr5DH%2BCoinpS1Qokbr01nCbbHZH%2F%2B9xqci%2FHio6V1u1yQpTv813sHmSZRWdM7ZG0Pi10GjQ4CBO9OJkLPIlSLfdBkUV2tiBH3LKZ; ZZ1-Session__1505-Alt=CfDJ8KSkO661hSREsDx7PGb48%2B0fOXlRvUezw9rOk1y%2B4N7%2F3TSehLuHqXnOE0LYrXcLNAaeyRbbHr5DH%2BCoinpS1Qokbr01nCbbHZH%2F%2B9xqci%2FHio6V1u1yQpTv813sHmSZRWdM7ZG0Pi10GjQ4CBO9OJkLPIlSLfdBkUV2tiBH3LKZ' \
--data ''

Response

  
 <Result>
  <APIRequestInfo>
    <ProviderVersion>KOBE.R2.2065G.216363</ProviderVersion>
    <ProviderIdentity>OLU-T-USW2-APP</ProviderIdentity>
    <ProviderID>44ddde3ac27a33c394335f249d4007d4</ProviderID>
    <Module>DataTable</Module>
    <APIVersion>v2.2</APIVersion>
    <Resource>Documents.Folder.Event-Folder:Update</Resource>
    <IsLoggedIn type="Boolean">True</IsLoggedIn>
    <Status>LoggedIn</Status>
    <UserLogin>ZZ1CT12217</UserLogin>
    <Session>No session (production configuration)</Session>
    <TimeoutPeriodMinutes type="Numeric">120</TimeoutPeriodMinutes>
  </APIRequestInfo>
  <RequestInterpretation>
    <Filters type="List">
      <Filter>
        <Field>CoreField.Identifier</Field>
        <Operator>=</Operator>
        <OperatorDescription>Field must be equal to value</OperatorDescription>
        <Value>ZZ13VPB</Value>
      </Filter>
    </Filters>
    <Updates type="List">
      <Update>
        <Field>CoreField.Representative_DO</Field>
        <Operator>:=</Operator>
        <OperatorDescription>Assign a value to a single-value field</OperatorDescription>
        <Value>[DataTable/v2.2/Documents.Image.Production-Still:Read?CoreField.Identifier=ZZ17HB]</Value>
      </Update>
    </Updates>
    <IgnoredParameters type="List" />
  </RequestInterpretation>
  <ResponseSummary>
    <NumberOfRecordsAffected type="Numeric">1</NumberOfRecordsAffected>
  </ResponseSummary>
  <Response>
    <RecordsAffected type="List">
      <Result>
        <RecordID>2QDTWAO0H8U</RecordID>
        <Code>SUCCESS</Code>
      </Result>
    </RecordsAffected>
  </Response>
</Result>

Example 2: Remove an asset's representative image

This call removes the representative image from the folder with the legacy identifier FolderThree because no asset is identified as the representative. After you run this call, FolderThree no longer displays a representative image.

POST or GET/API/DataTable/v2.2/Documents.Folder.Default:Update?CoreField.ID_Client=FolderThree&CoreField.Representative_DO:=