Qodex.ai

dfareporting.order Documents.list

GET {{baseUrl}}/userprofiles/:profileId/projects/:projectId/orderDocuments?approved=<boolean>&ids=<string>&ids=<string>&maxResults=<integer>&orderId=<string>&orderId=<string>&pageToken=<string>&searchString=<string>&siteId=<string>&siteId=<string>&sortField=<string>&sortOrder=<string>&$.xgafv=<string>&access_token=<string>&alt=<string>&callback=<string>&fields=<string>&key=<string>&oauth_token=<string>&prettyPrint=<boolean>&quotaUser=<string>&upload_protocol=<string>&uploadType=<string>

Retrieves a list of order documents, possibly filtered. This method supports paging.

Request Params

KeyDatatypeRequiredDescription
approvedstringSelect only order documents that have been approved by at least one user.
idsstringSelect only order documents with these IDs.
idsstringSelect only order documents with these IDs.
maxResultsstringMaximum number of results to return.
orderIdstringSelect only order documents for specified orders.
orderIdstringSelect only order documents for specified orders.
pageTokenstringValue of the nextPageToken from the previous result page.
searchStringstringAllows searching for order documents by name or ID. Wildcards () are allowed. For example, "orderdocument2015" will return order documents with names like "orderdocument June 2015", "orderdocument April 2015", or simply "orderdocument 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "orderdocument" will match order documents with name "my orderdocument", "orderdocument 2015", or simply "orderdocument".
siteIdstringSelect only order documents that are associated with these sites.
siteIdstringSelect only order documents that are associated with these sites.
sortFieldstringField by which to sort the list.
sortOrderstringOrder of sorted results.
$.xgafvstringV1 error format.
access_tokenstringOAuth access token.
altstringData format for response.
callbackstringJSONP
fieldsstringSelector specifying which fields to include in a partial response.
keystringAPI key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
oauth_tokenstringOAuth 2.0 token for the current user.
prettyPrintstringReturns response with indentations and line breaks.
quotaUserstringAvailable to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
upload_protocolstringUpload protocol for media (e.g. "raw", "multipart").
uploadTypestringLegacy upload protocol for media (e.g. "media", "multipart").

RESPONSES

status: OK

{&quot;kind&quot;:&quot;adipisicing aliquip voluptate est&quot;,&quot;nextPageToken&quot;:&quot;exercitation quis ut&quot;,&quot;orderDocuments&quot;:[{&quot;accountId&quot;:&quot;Excepteur&quot;,&quot;advertiserId&quot;:&quot;sit culpa ea eu&quot;,&quot;amendedOrderDocumentId&quot;:&quot;ipsum&quot;,&quot;approvedByUserProfileIds&quot;:[&quot;Excepteur quis&quot;,&quot;dolor cupidatat mollit sed&quot;],&quot;cancelled&quot;:true,&quot;createdInfo&quot;:{&quot;time&quot;:&quot;et aute in laborum exercitation&quot;},&quot;effectiveDate&quot;:&quot;1992-04-16&quot;,&quot;id&quot;:&quot;ipsum reprehenderit&quot;,&quot;kind&quot;:&quot;deserunt in exercitation in&quot;,&quot;lastSentRecipients&quot;:[&quot;reprehenderit&quot;,&quot;amet proident dolor&quot;],&quot;lastSentTime&quot;:&quot;1961-08-16T15:52:46.587Z&quot;,&quot;orderId&quot;:&quot;reprehenderit ullamco&quot;,&quot;projectId&quot;:&quot;occaecat nostrud ea&quot;,&quot;signed&quot;:false,&quot;subaccountId&quot;:&quot;officia fugiat eu&quot;,&quot;title&quot;:&quot;cupidatat eu&quot;,&quot;type&quot;:&quot;PLANNING_ORDER_TYPE_INSERTION_ORDER&quot;},{&quot;accountId&quot;:&quot;commodo amet&quot;,&quot;advertiserId&quot;:&quot;deserunt cillum aliqua&quot;,&quot;amendedOrderDocumentId&quot;:&quot;ullamco dolor&quot;,&quot;approvedByUserProfileIds&quot;:[&quot;cupidatat consequat occaecat in&quot;,&quot;tempor dolor&quot;],&quot;cancelled&quot;:false,&quot;createdInfo&quot;:{&quot;time&quot;:&quot;fugiat eiusmod laboris laborum&quot;},&quot;effectiveDate&quot;:&quot;1976-06-11&quot;,&quot;id&quot;:&quot;tempor incididunt&quot;,&quot;kind&quot;:&quot;eiusmod&quot;,&quot;lastSentRecipients&quot;:[&quot;amet laboris est&quot;,&quot;quis ex est sunt&quot;],&quot;lastSentTime&quot;:&quot;2005-12-30T20:43:43.233Z&quot;,&quot;orderId&quot;:&quot;ut dolore veniam eu&quot;,&quot;projectId&quot;:&quot;aliqua&quot;,&quot;signed&quot;:false,&quot;subaccountId&quot;:&quot;officia dolore&quot;,&quot;title&quot;:&quot;non nostrud&quot;,&quot;type&quot;:&quot;PLANNING_ORDER_TYPE_INSERTION_ORDER&quot;}]}