Visibility - Get document lifecycle

GET {{baseUrl}}/visibilityServices/v1/documentLifecycles?startDate=nu&endDate=nu&primaryKey=nu&searchKeys=nu&mailbox=nu&partnerCompanyReference=nu&tradingAddress=nu&partnerTradingAddress=nu&direction=ALL&docType=nu&processStatus=nu&after=0&limit=25

Search for document lifecycle based on search parameters

Request Params

KeyDatatypeRequiredDescription
startDatestringStart Date in ISO 8601 format
endDatestringEnd Date in ISO 8601 format
primaryKeystringPrimary key (one key/value pair in the form of parm_name1=value1)
searchKeysstringSearchable keys (in the form of parm_name1=value1, parm_name2=value2, ...)
mailboxstringTrading Grid mailbox if applicable
partnerCompanyReferencestringTrading Partner Organization Identity as defined by the Trading Grid Community Master Data Service.
tradingAddressstringTrading (EDI or binary routing) address
partnerTradingAddressstringPartner Trading (EDI or binary routing) address
directionstringIndicates if the transaction was sent to (inbound) or sent from (outbound) the perspective of the Customer {both, sent, receive}
docTypestringTransaction type in the envelope if EDI, or assigned by sender if binary data
processStatusstringCurrent Process Status
afternumberThe position of starting record for collection page. Should be used together with LIMIT parameter. Can not be used in combination of BEFORE parameter,
limitnumberNumber of elements in result collection.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

[{"resultSetStatus":{"statusCode":"qui ea mollit","statusSubCode":"est exercitation do","statusMessage":"consequat sed"},"totalCount":-7598222,"distinctSummary":{"partnerInfo":[{"buReference":{"companyName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"orgId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rootOrgId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"totalCount":-92238119},{"buReference":{"companyName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"orgId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rootOrgId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"totalCount":42858948}],"senderAddresses":[{"address":"do","totalCount":54903387},{"address":"minim esse occaecat","totalCount":51153979}],"receiverAddreses":[{"address":"ullamco elit","totalCount":24250874},{"address":"nisi ea in","totalCount":-13913143}],"processingStatus":[{"processingStatus":"ullamco esse irure veniam eiusmod","totalCount":44221389},{"processingStatus":"ut non","totalCount":75290692}],"processingDirection":[{"processingDirection":"INBOUND","totalCount":91748612},{"processingDirection":"OUTBOUND","totalCount":-84957891}],"documentType":[{"documentType":"enim irure dolore eu fugiat","totalCount":8728824},{"documentType":"aliqua enim est laborum","totalCount":65257865}],"reconStatus":[{"totalCount":-91395924,"reconStatus":"consequat dolore qui laborum"},{"totalCount":-23855101,"reconStatus":"deserunt"}],"reprocessedStatus":[{"totalCount":-99937501,"reprocessed":"aute ipsum mollit voluptate sunt"},{"totalCount":-44962860,"reprocessed":"velit in"}]},"lifecycle":[{"perspectiveType":"iru","processReference":[{"processId":"aliqua veniam","processStatus":"sed voluptate","processRole":"consectetur non ali"},{"processId":"do esse","processStatus":"aliqua ullamco non","processRole":"consectetur "}],"selectedFields":{"selectedField":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"totalCount":-80061208},"contentFile":{"docType":"qui","receiver":{"companyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"companyName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rootCompanyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tradingAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"sender":{"companyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"companyName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rootCompanyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tradingAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"snrf":"esse tempor non nulla","storageKey":"laboris","storageType":"nulla consequat","solutionId":"et","contentId":"aliquip non irure"},"envelope":{"envelopeType":"nostrud dolore enim proident ad","receiver":{"companyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"companyName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rootCompanyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tradingAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"sender":{"companyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"companyName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rootCompanyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tradingAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"snrf":"commodo ullamco","solutionId":"dolor nulla l","contentId":"cupidatat et in voluptate","envelopeStandard":"Duis consectetur ea dolor"},"document":{"docType":"minim ut sunt magna","receiver":{"companyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"companyName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rootCompanyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tradingAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"sender":{"companyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"companyName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rootCompanyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tradingAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"snrf":"non l","solutionId":"cillum","contentId":"in in pariatur"},"lifecycleId":"elit laborum","lifecycleCreateDate":"sit"},{"perspectiveType":"eu elit nostrud","processReference":[{"processId":"ipsum veniam laboris sunt amet","processStatus":"elit ipsum","processRole":"mollit sint Lorem id anim"},{"processId":"incididunt","processStatus":"ea do enim labo","processRole":"id ea ut aute Ut"}],"selectedFields":{"selectedField":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"totalCount":28743328},"contentFile":{"docType":"Lorem adipisicing amet do pa","receiver":{"companyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"companyName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rootCompanyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tradingAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"sender":{"companyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"companyName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rootCompanyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tradingAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"snrf":"enim consequat nulla","storageKey":"do laborum esse aute","storageType":"adipisicing laboris id","solutionId":"dolor minim qui ea","contentId":"commodo sint enim ipsum"},"envelope":{"envelopeType":"ea","receiver":{"companyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"companyName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rootCompanyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tradingAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"sender":{"companyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"companyName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rootCompanyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tradingAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"snrf":"ut dolor","solutionId":"dolore pro","contentId":"Duis dolore ad proident sint","envelopeStandard":"laboris sint officia"},"document":{"docType":"nulla aute","receiver":{"companyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"companyName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rootCompanyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tradingAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"sender":{"companyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"companyName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rootCompanyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tradingAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"snrf":"laborum occaecat incididunt esse officia","solutionId":"aute ut fugiat","contentId":"Lorem occaecat consequat"},"lifecycleId":"laborum Excepteur elit","lifecycleCreateDate":"est et"}]},{"resultSetStatus":{"statusCode":"non nostrud ea","statusSubCode":"laborum","statusMessage":"adipisicing aliquip"},"totalCount":51889231,"distinctSummary":{"partnerInfo":[{"buReference":{"companyName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"orgId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rootOrgId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"totalCount":-52193689},{"buReference":{"companyName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"orgId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rootOrgId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"totalCount":10012619}],"senderAddresses":[{"address":"pariatur labore","totalCount":-93525744},{"address":"laborum sint Lorem","totalCount":97720666}],"receiverAddreses":[{"address":"amet in incididunt","totalCount":54057304},{"address":"elit nulla aliquip ut pariatur","totalCount":-47530431}],"processingStatus":[{"processingStatus":"dolore","totalCount":73086930},{"processingStatus":"est ad","totalCount":-65120499}],"processingDirection":[{"processingDirection":"UNKNOWN","totalCount":87582087},{"processingDirection":"OUTBOUND","totalCount":-75914715}],"documentType":[{"documentType":"Lorem cupidatat ad anim","totalCount":8041223},{"documentType":"ex ull","totalCount":59018118}],"reconStatus":[{"totalCount":61829050,"reconStatus":"enim dolor quis"},{"totalCount":-95018849,"reconStatus":"Lorem ea velit"}],"reprocessedStatus":[{"totalCount":52326516,"reprocessed":"ut officia"},{"totalCount":41741011,"reprocessed":"Excepteur in proident aliquip"}]},"lifecycle":[{"perspectiveType":"elit reprehenderit laboris aliqua dolore","processReference":[{"processId":"cillum culpa commodo laboris","processStatus":"Excepteur esse enim nulla","processRole":"irure non est"},{"processId":"incididunt nulla","processStatus":"et dolore elit ea consectetur","processRole":"nisi amet"}],"selectedFields":{"selectedField":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"totalCount":-44423041},"contentFile":{"docType":"adipisicing","receiver":{"companyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"companyName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rootCompanyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tradingAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"sender":{"companyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"companyName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rootCompanyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tradingAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"snrf":"pariatur quis ea mollit","storageKey":"nulla cillum sunt","storageType":"amet","solutionId":"anim","contentId":"qui in ullamco minim"},"envelope":{"envelopeType":"incididunt id qui commodo sunt","receiver":{"companyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"companyName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rootCompanyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tradingAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"sender":{"companyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"companyName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rootCompanyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tradingAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"snrf":"dolor","solutionId":"veniam sit ex","contentId":"magna eiusmod","envelopeStandard":"culpa irure labore"},"document":{"docType":"aliquip consectetur","receiver":{"companyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"companyName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rootCompanyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tradingAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"sender":{"companyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"companyName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rootCompanyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tradingAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"snrf":"qui dolor labore","solutionId":"adip","contentId":"magna in"},"lifecycleId":"nostrud non ut minim aute","lifecycleCreateDate":"id"},{"perspectiveType":"reprehenderit eiusmod","processReference":[{"processId":"Duis culpa consequat amet proident","processStatus":"voluptate u","processRole":"deserunt commodo"},{"processId":"quis fugiat magna","processStatus":"minim reprehenderit","processRole":"eiusmod aute nulla"}],"selectedFields":{"selectedField":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"totalCount":-33389307},"contentFile":{"docType":"amet reprehenderit commodo","receiver":{"companyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"companyName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rootCompanyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tradingAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"sender":{"companyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"companyName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rootCompanyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tradingAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"snrf":"dolor incididunt","storageKey":"aliquip ut","storageType":"veniam exercitation in","solutionId":"pariatur elit","contentId":"nostrud"},"envelope":{"envelopeType":"sint sunt elit aute occaecat","receiver":{"companyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"companyName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rootCompanyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tradingAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"sender":{"companyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"companyName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rootCompanyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tradingAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"snrf":"id ad fugiat qui","solutionId":"veniam fugiat eu","contentId":"occ","envelopeStandard":"in non in"},"document":{"docType":"incididunt eu","receiver":{"companyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"companyName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rootCompanyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tradingAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"sender":{"companyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"companyName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"rootCompanyId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tradingAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"snrf":"veniam voluptate ea","solutionId":"aliquip dolore","contentId":"velit dolore in"},"lifecycleId":"nulla ut commodo","lifecycleCreateDate":"ipsum laborum qui"}]}]