API Reference

Update tags

Add tags to or remove them from an asset’s “Tags” tab

Call template

All DataTable calls can be POST or GET.

https://{OrangeLogicURL}/API/DataTable/V2.2/Documents.{type}.{subtype}:Update?{asset identifier}&CoreField.Keywords{operator}{tags separated by pipes}

Specify the asset type and subtype, provide an asset identifier, and then use an operator to add or remove a pipe-delineated list of tags. Use this structure to add existing or new tags to an asset. You can also remove one or all tags from an asset.

Use this same structure to update any authority list by replacing CoreField.Keywords with the API name of the authority list field.

Update

Example 1: Add tags to an asset when the values already exist in Orange Logic

This call adds the tags “Seine river,” “Eiffel Tower,” and “France” to a Standard Image with the identifier ZZ12PAR. All three tags are already available in Orange Logic.

/API/DataTable/V2.2/Documents.Image.Default:Update?CoreField.Identifier=ZZ12PAR&CoreField.Keywords+=Seine river|Eiffel Tower|France

ℹ️

Note

The += operator adds only values that already exist as tags in your Orange Logic instance. The call will fail if you specify tags that don’t already exist. To add new values as tags and apply them to the specified asset , use the ++= operator.

Example call 
curl --location --request POST 'https://mangovations.com/API/DataTable/V2.2/Documents.Image.Default:Update?CoreField.Identifier=ZZ12PAR&CoreField.Keywords+=Seine%20river%7CEiffel%20Tower%7CFrance' \
--header 'Authorization: Bearer C6AphOAFflFs@JmCa0JDEPey10L8b6aOBB5dNjtWx8UOQ@[email protected]@jWUP..uxeG35x7haffTsKrIf6WyL5e' \
--header 'Cookie: AWSALB=1hWS8gk0qcy4MsRHf37h+3ouICret4pq6YMPo2faWgly4WEhhJSRDFKaZGqaeFjqzKE2wvO74jvW+Q1hKsamAdy5lQJQUO2SKJ/rlRoqQsuJ2WnlDrP2+BMPbZzP; AWSALBCORS=1hWS8gk0qcy4MsRHf37h+3ouICret4pq6YMPo2faWgly4WEhhJSRDFKaZGqaeFjqzKE2wvO74jvW+Q1hKsamAdy5lQJQUO2SKJ/rlRoqQsuJ2WnlDrP2+BMPbZzP; AWSALBTG=95V49tRv5HI9HuphbeImjL3Gsrrb7Tg1HQIAfROEXCW3IHeGoSpJMvhYQB+09kCCs/z9tW8jCJsYW5V4/Pdy/qvdlsn8yvwEWrTPZZFis/qMsuom1MRAeH2rwjzGXhHpFeUJfqeyJ5EiVyP4UXe3LqHKP2XRiGU95jHvRSYQKWdY; AWSALBTGCORS=95V49tRv5HI9HuphbeImjL3Gsrrb7Tg1HQIAfROEXCW3IHeGoSpJMvhYQB+09kCCs/z9tW8jCJsYW5V4/Pdy/qvdlsn8yvwEWrTPZZFis/qMsuom1MRAeH2rwjzGXhHpFeUJfqeyJ5EiVyP4UXe3LqHKP2XRiGU95jHvRSYQKWdY; ZZ1-Session__1505=CfDJ8KSkO661hSREsDx7PGb48%2B32d0QnYqgiUJTd8Ep1n2wPm6yEH%2FVMAr24RXi71ruXn%2Fo%2BUXF3pSjCFVS5QJK%2Fir%2Be3AMDVNJpIyl8qTuqxbQGYAhV3A0A1iBKN8cNXWCrzf6kG%2FdfN7ffNFQqUwyty2I3gNgJ%2BKP9rn3KadeC3YOm; ZZ1-Session__1505-Alt=CfDJ8KSkO661hSREsDx7PGb48%2B32d0QnYqgiUJTd8Ep1n2wPm6yEH%2FVMAr24RXi71ruXn%2Fo%2BUXF3pSjCFVS5QJK%2Fir%2Be3AMDVNJpIyl8qTuqxbQGYAhV3A0A1iBKN8cNXWCrzf6kG%2FdfN7ffNFQqUwyty2I3gNgJ%2BKP9rn3KadeC3YOm'
Response 
<Result>
  <APIRequestInfo>
    <ProviderVersion>KOBE.R2.2065G.216363</ProviderVersion>
    <ProviderIdentity>CUY-T-USW2-APP</ProviderIdentity>
    <ProviderID>44ddde3ac27a33c394335f249d4007d4</ProviderID>
    <Module>DataTable</Module>
    <APIVersion>V2.2</APIVersion>
    <Resource>Documents.Image.Default:Update</Resource>
    <IsLoggedIn type="Boolean">True</IsLoggedIn>
    <Status>LoggedIn</Status>
    <UserLogin>ZZ1CT12218</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>ZZ12PAR</Value>
      </Filter>
    </Filters>
    <Updates type="List">
      <Update>
        <Field>CoreField.Keywords</Field>
        <Operator>+=</Operator>
        <OperatorDescription>Add a value or a list of values (separated by |) to a multi-value field</OperatorDescription>
        <Value>Seine river|Eiffel Tower|France</Value>
      </Update>
    </Updates>
    <IgnoredParameters type="List" />
  </RequestInterpretation>
  <ResponseSummary>
    <NumberOfRecordsAffected type="Numeric">1</NumberOfRecordsAffected>
  </ResponseSummary>
  <Response>
    <RecordsAffected type="List">
      <Result>
        <RecordID>2QDTWAGP1T3</RecordID>
        <Code>SUCCESS</Code>
      </Result>
    </RecordsAffected>
  </Response>
</Result>

Example 2: Create tags in Orange Logic and add them to an asset

This call creates the tags “River Thames,” “Tower of London,” and “England” and applies them to a Standard Image with the identifier ZZ12PAR.

/API/DataTable/V2.2/Documents.Image.Default:Update?CoreField.Identifier=ZZ12PAR&CoreField.Keywords++=River Thames|Tower of London|England

Example call 
curl --location --request POST 'https://mangovations.com/API/DataTable/V2.2/Documents.Image.Default:Update?CoreField.Identifier=ZZ12PAR&CoreField.Keywords++=River%20Thames%7CTower%20of%20London%7CEngland' \
--header 'Authorization: Bearer C6AphOAFflFs@JmCa0JDEPey10L8b6aOBB5dNjtWx8UOQ@[email protected]@jWUP..uxeG35x7haffTsKrIf6WyL5e' \
--header 'Cookie: AWSALB=YOPd/vOUazHh29ZmD0eF0/i5RvcQP1v4rr8lVY/tsKLZwfqUxkTqpy1ZhDjRCY/PSGBVO5QCN+GXzJ6BvLkukkRgk4/sj7soMfOYpfZe8IdQr8X8cU6S7Im2N2Me; AWSALBCORS=YOPd/vOUazHh29ZmD0eF0/i5RvcQP1v4rr8lVY/tsKLZwfqUxkTqpy1ZhDjRCY/PSGBVO5QCN+GXzJ6BvLkukkRgk4/sj7soMfOYpfZe8IdQr8X8cU6S7Im2N2Me; AWSALBTG=Fo9JZrmnbAyTFJsyYrmHrdTTjLwEX07eP9CtZvIKLj+LXpllZfkKARdGIT5cglxjcrSIQxju0fP+UuR7GuWsRC1cVOaTyfAO6lAf4It6Xy3CbKk446X4xu5+4coQE/MGuzV5eSXV7TRtHnx46p74SSZ9l+QFcXCLmz1XyFpWiuVc; AWSALBTGCORS=Fo9JZrmnbAyTFJsyYrmHrdTTjLwEX07eP9CtZvIKLj+LXpllZfkKARdGIT5cglxjcrSIQxju0fP+UuR7GuWsRC1cVOaTyfAO6lAf4It6Xy3CbKk446X4xu5+4coQE/MGuzV5eSXV7TRtHnx46p74SSZ9l+QFcXCLmz1XyFpWiuVc; ZZ1-Session__1505=CfDJ8KSkO661hSREsDx7PGb48%2B2o%2BQ5qc8hIgCRoSs%2BXJlLtXfVxsPaJS8nh%2FVDdvwxxnkCPhm8iONcAj8WfmADn2znoS3gnXTjhlQ2VbXPDpa07pcvdycee6lfYP7KaVPY6prl7xNdWnRoyhqz6zL9ZowFybILjZmoblvvui9Ywb2Yf; ZZ1-Session__1505-Alt=CfDJ8KSkO661hSREsDx7PGb48%2B2o%2BQ5qc8hIgCRoSs%2BXJlLtXfVxsPaJS8nh%2FVDdvwxxnkCPhm8iONcAj8WfmADn2znoS3gnXTjhlQ2VbXPDpa07pcvdycee6lfYP7KaVPY6prl7xNdWnRoyhqz6zL9ZowFybILjZmoblvvui9Ywb2Yf'
Response 
<Result>
  <APIRequestInfo>
    <ProviderVersion>KOBE.R2.2065G.216363</ProviderVersion>
    <ProviderIdentity>CUY-T-USW2-APP</ProviderIdentity>
    <ProviderID>44ddde3ac27a33c394335f249d4007d4</ProviderID>
    <Module>DataTable</Module>
    <APIVersion>V2.2</APIVersion>
    <Resource>Documents.Image.Default:Update</Resource>
    <IsLoggedIn type="Boolean">True</IsLoggedIn>
    <Status>LoggedIn</Status>
    <UserLogin>ZZ1CT12218</UserLogin>
    <Session>No session (production configuration)</Session>
    <TimeoutPeriodMinutes type="Numeric">20</TimeoutPeriodMinutes>
  </APIRequestInfo>
  <RequestInterpretation>
    <Filters type="List">
      <Filter>
        <Field>CoreField.Identifier</Field>
        <Operator>=</Operator>
        <OperatorDescription>Field must be equal to value</OperatorDescription>
        <Value>ZZ12PAR</Value>
      </Filter>
    </Filters>
    <Updates type="List">
      <Update>
        <Field>CoreField.Keywords</Field>
        <Operator>++=</Operator>
        <OperatorDescription>Add a value to a multi-value field that is based on an authority table. Create the value if it does not exist in the authority table, yet.</OperatorDescription>
        <Value>River Thames|Tower of London|England</Value>
      </Update>
    </Updates>
    <IgnoredParameters type="List" />
  </RequestInterpretation>
  <ResponseSummary>
    <NumberOfRecordsAffected type="Numeric">1</NumberOfRecordsAffected>
  </ResponseSummary>
  <Response>
    <RecordsAffected type="List">
      <Result>
        <RecordID>2QDTWAGP1T3</RecordID>
        <Code>SUCCESS</Code>
      </Result>
    </RecordsAffected>
  </Response>
</Result>

Example 3: Remove all tags from an asset

This call removes all tags from the Standard Image with the identifier ZZ12PAR. The tags continue to exist in Orange Logic, but they are no longer applied to the asset.

/API/DataTable/V2.2/Documents.Image.Default:Update?CoreField.Identifier=ZZ12PAR&CoreField.Keywords--=

ℹ️

Note

The --= operator removes all tags from an asset. To remove a individual tags, use the -= operator and separate tags with a pipe (|). For example:

/API/DataTable/V2.2/Documents.Image.Default:Update?CoreField.Identifier=ZZ12PAR&CoreField.Keywords-=River Thames|Tower of London

Example call 
curl --location --request POST 'https://mangovations.com/API/DataTable/V2.2/Documents.Image.Default:Update?CoreField.Identifier=ZZ12PAR&CoreField.Keywords--=' \
--header 'Authorization: Bearer C6AphOAFflFs@JmCa0JDEPey10L8b6aOBB5dNjtWx8UOQ@[email protected]@jWUP..uxeG35x7haffTsKrIf6WyL5e' \
--header 'Cookie: AWSALB=6+HGAiGyUMVAZmD0TUPcEYMJeLmbr1sBoZQFzEQu0piMmKhMUqP21dSY1ryYWXb96o7LfeAujTluXpZ76+xqJwVQm5Ro5VAICvPn3Urvip9rApE5lKgZwsYJLPRl; AWSALBCORS=6+HGAiGyUMVAZmD0TUPcEYMJeLmbr1sBoZQFzEQu0piMmKhMUqP21dSY1ryYWXb96o7LfeAujTluXpZ76+xqJwVQm5Ro5VAICvPn3Urvip9rApE5lKgZwsYJLPRl; AWSALBTG=cJ8GoIg7HfBkNKWmoBsPfzzb5NXkKVGbG3IXOkRao4A4QpP5q+6s34xHH7TAxkkyCJBF3U1Gl6N7vyFCzn2BbMqhySd6yIrNmlcDUcZKEQafmn8D+ab1fyyrp+Bo95uhe7m58saUMLdgdXAAxec98Bv8FTgS55grnVny2yRXCy5F; AWSALBTGCORS=cJ8GoIg7HfBkNKWmoBsPfzzb5NXkKVGbG3IXOkRao4A4QpP5q+6s34xHH7TAxkkyCJBF3U1Gl6N7vyFCzn2BbMqhySd6yIrNmlcDUcZKEQafmn8D+ab1fyyrp+Bo95uhe7m58saUMLdgdXAAxec98Bv8FTgS55grnVny2yRXCy5F; ZZ1-Session__1505=CfDJ8KSkO661hSREsDx7PGb48%2B0kQCFInyUZmFCHGlZwSnD8M%2BSpMhi5NqQaxSkmbQXZ%2BAcj8YWjE%2FQTUMlgkylpsuaZwiUjOqN7Qt36IZvn9Z7VZz0dtEvzOTqMt%2B8hQgLMYilwzCiIxBp5rbLesl%2BxKGe2UxfYusf3vNag7tDTYJEp; ZZ1-Session__1505-Alt=CfDJ8KSkO661hSREsDx7PGb48%2B0kQCFInyUZmFCHGlZwSnD8M%2BSpMhi5NqQaxSkmbQXZ%2BAcj8YWjE%2FQTUMlgkylpsuaZwiUjOqN7Qt36IZvn9Z7VZz0dtEvzOTqMt%2B8hQgLMYilwzCiIxBp5rbLesl%2BxKGe2UxfYusf3vNag7tDTYJEp'
Result 
<Result>
  <APIRequestInfo>
    <ProviderVersion>KOBE.R2.2065G.216363</ProviderVersion>
    <ProviderIdentity>CUY-T-USW2-APP</ProviderIdentity>
    <ProviderID>44ddde3ac27a33c394335f249d4007d4</ProviderID>
    <Module>DataTable</Module>
    <APIVersion>V2.2</APIVersion>
    <Resource>Documents.Image.Default:Update</Resource>
    <IsLoggedIn type="Boolean">True</IsLoggedIn>
    <Status>LoggedIn</Status>
    <UserLogin>ZZ1CT12218</UserLogin>
    <Session>No session (production configuration)</Session>
    <TimeoutPeriodMinutes type="Numeric">20</TimeoutPeriodMinutes>
  </APIRequestInfo>
  <RequestInterpretation>
    <Filters type="List">
      <Filter>
        <Field>CoreField.Identifier</Field>
        <Operator>=</Operator>
        <OperatorDescription>Field must be equal to value</OperatorDescription>
        <Value>ZZ12PAR</Value>
      </Filter>
    </Filters>
    <Updates type="List">
      <Update>
        <Field>CoreField.Keywords</Field>
        <Operator>--=</Operator>
        <OperatorDescription>Remove all values from a multi-value field</OperatorDescription>
        <Value></Value>
      </Update>
    </Updates>
    <IgnoredParameters type="List" />
  </RequestInterpretation>
  <ResponseSummary>
    <NumberOfRecordsAffected type="Numeric">1</NumberOfRecordsAffected>
  </ResponseSummary>
  <Response>
    <RecordsAffected type="List">
      <Result>
        <RecordID>2QDTWAGP1T3</RecordID>
        <Code>SUCCESS</Code>
      </Result>
    </RecordsAffected>
  </Response>
</Result>

Example 4: Remove all tags and add a tag

This call uses the --= operator to remove all tags from the Standard Image with the identifier ZZ12PAR. It then uses the += operator to add the tag “France.”

/API/DataTable/V2.2/Documents.Image.Default:Update?CoreField.Identifier=ZZ12PAR&CoreField.Keywords--=&CoreField.Keywords+=France

Example call 
curl --location --request POST 'https://mangovations.com/API/DataTable/V2.2/Documents.Image.Default:Update?CoreField.Identifier=ZZ12PAR&CoreField.Keywords--=&CoreField.Keywords+=France' \
--header 'Authorization: Bearer @7Xm1EK1hlUgJWY0@RUTHaYYSTa516C841beZyYf2oBEvZLoL4JzV.5bz2sPEyKaI267Cy@[email protected]@wu1nV1P6Lj9FY' \
--header 'Cookie: AWSALB=73UZj8/Q9AF/N7pC/vVK8mEpB1XOAm35A4ZTKxay6mPXhouADRnirwxOqhXLr4EtA4Yk3+jVrxvZ83BXB56yhZPM+GXurgSQpHfyeRUZgKgEsPrCYQSaN1sPOuy5; AWSALBCORS=73UZj8/Q9AF/N7pC/vVK8mEpB1XOAm35A4ZTKxay6mPXhouADRnirwxOqhXLr4EtA4Yk3+jVrxvZ83BXB56yhZPM+GXurgSQpHfyeRUZgKgEsPrCYQSaN1sPOuy5; AWSALBTG=SYz5S00Wh1U7kc38nhlb5Jb8DIr3AfWn0g0TVq1KMeptyU3awqjSd845HONB9XADpUHoY8x2FVRJ56o7rhebaD8x3ShrJLkBImFPwWkFoAVelnkFFYUaXHYMagMj2ao6+8zVWyQfUJT+JpYoXfAiOL+cuWZAmvJ/2mNRhvWMUTHM; AWSALBTGCORS=SYz5S00Wh1U7kc38nhlb5Jb8DIr3AfWn0g0TVq1KMeptyU3awqjSd845HONB9XADpUHoY8x2FVRJ56o7rhebaD8x3ShrJLkBImFPwWkFoAVelnkFFYUaXHYMagMj2ao6+8zVWyQfUJT+JpYoXfAiOL+cuWZAmvJ/2mNRhvWMUTHM; ZZ1-Session__1505=CfDJ8KSkO661hSREsDx7PGb48%2B2sj4EKPqD4Z4x%2Bh1tAO0btQuRT8CgJb8gUTBIyW0uyJZKWKojggQdgyoUEmCm4mIeHSrlUE6SKFJ%2BXFD1zArZsNZCH2PMSiPylzG6CNg0MAYWsw%2FLByQsrWDgS8hz0%2FzmiUP6tJ8H7YgzI%2FqKt08wA; ZZ1-Session__1505-Alt=CfDJ8KSkO661hSREsDx7PGb48%2B2sj4EKPqD4Z4x%2Bh1tAO0btQuRT8CgJb8gUTBIyW0uyJZKWKojggQdgyoUEmCm4mIeHSrlUE6SKFJ%2BXFD1zArZsNZCH2PMSiPylzG6CNg0MAYWsw%2FLByQsrWDgS8hz0%2FzmiUP6tJ8H7YgzI%2FqKt08wA'
Result 
<Result>
  <APIRequestInfo>
    <ProviderVersion>KOBE.R2.2065G.216363</ProviderVersion>
    <ProviderIdentity>CUY-T-USW2-APP</ProviderIdentity>
    <ProviderID>44ddde3ac27a33c394335f249d4007d4</ProviderID>
    <Module>DataTable</Module>
    <APIVersion>V2.2</APIVersion>
    <Resource>Documents.Image.Default:Update</Resource>
    <IsLoggedIn type="Boolean">True</IsLoggedIn>
    <Status>LoggedIn</Status>
    <UserLogin>ZZ1CT12218</UserLogin>
    <Session>No session (production configuration)</Session>
    <TimeoutPeriodMinutes type="Numeric">20</TimeoutPeriodMinutes>
  </APIRequestInfo>
  <RequestInterpretation>
    <Filters type="List">
      <Filter>
        <Field>CoreField.Identifier</Field>
        <Operator>=</Operator>
        <OperatorDescription>Field must be equal to value</OperatorDescription>
        <Value>ZZ12PAR</Value>
      </Filter>
    </Filters>
    <Updates type="List">
      <Update>
        <Field>CoreField.Keywords</Field>
        <Operator>--=</Operator>
        <OperatorDescription>Remove all values from a multi-value field</OperatorDescription>
        <Value></Value>
      </Update>
      <Update>
        <Field>CoreField.Keywords</Field>
        <Operator>+=</Operator>
        <OperatorDescription>Add a value or a list of values (separated by |) to a multi-value field</OperatorDescription>
        <Value>France</Value>
      </Update>
    </Updates>
    <IgnoredParameters type="List" />
  </RequestInterpretation>
  <ResponseSummary>
    <NumberOfRecordsAffected type="Numeric">1</NumberOfRecordsAffected>
  </ResponseSummary>
  <Response>
    <RecordsAffected type="List">
      <Result>
        <RecordID>2QDTWAGP1T3</RecordID>
        <Code>SUCCESS</Code>
      </Result>
    </RecordsAffected>
  </Response>
</Result>