Bot Reviews

Search AI brand reviews

Changed on

Returns AI brand-review results produced for a document version under an approval. Each review is generated when a bot reviewer participant runs against a stage on the approval and captures the bot’s pass/fail findings against the brand’s guidelines. Filter results by bot, document version, parent document, or stage to narrow the response to a specific asset, review run, or stage on its approval.

post/api/v1/bot-reviews/search

Request

  • Base URL: https://workfront.adobe.io/workfront-approvals
  • URL: https://workfront.adobe.io/workfront-approvals/api/v1/bot-reviews/search
  • Auth: HTTP bearer

Headers

x-api-keystring required

client_id of the Adobe Developer Console technical account. Identifies the calling integration to the AIO gateway.

x-gw-subdomainstring required

Workfront customer subdomain (e.g. mycompany). Must match the subdomain of the Workfront instance being accessed. Passing an incorrect or unrecognized subdomain will result in a 502 Bad Gateway response from the AIO gateway.

wf-customeridstring required

Workfront customer ID.

wf-useridstring required

Workfront user ID of the acting user.

wf-lane'prod' | 'preview' | 'hub' | 'staging' | 'devtest' required

Workfront deployment lane.

x-request-idstring uuid

Unique identifier for request tracing. Auto-generated if not provided.

x-correlation-idstring

Unique identifier for correlation across multiple service calls. Auto-generated if not provided.

Request body

botEauthUserIdstring

The Workfront eauthUserID of the bot. Maps to associatedTechnicalAccountId on the bot record. Required if objId and parentObjId are not provided.

parentObjType'DOCU'

Type of the parent object.

parentObjIdstring

ID of the parent object (the document). Required if objId and botEauthUserId are not provided.

objType'DOCV'

Type of the object being reviewed.

objIdstring

ID of the object being reviewed (the document version). Required if parentObjId and botEauthUserId are not provided.

stageIdstring

ID of the stage on the approval.

pageinteger
limitinteger

Response

OK

Changes