GET papi/v1/documentmanagementoutbound/data?locationCode={locationCode}&dateFrom={dateFrom}&dateTo={dateTo}&lastSyncedDate={lastSyncedDate}
Security
Secured API
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| locationCode | string |
Required |
|
| dateFrom | date |
Required |
|
| dateTo | date |
Required |
|
| lastSyncedDate | date |
Required |
Required Headers
| Name | Description | Sample | Type | Default |
|---|---|---|---|---|
| Authorization |
Represents the value of the authentication token. Allow multiple values: no. |
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ... | string | None |
| ConsumerId |
Represents the value of the consumer id. Allow multiple values: no. |
2426 | integer | None |
Optional Headers
| Name | Description | Sample | Type | Default |
|---|---|---|---|---|
| ApplicationType |
Represents the value of the consumer's application type. Allow multiple values: no. |
1 | ApplicationType | None |
| Accept-Language |
Represents the value of the desired language for translations. Allow multiple values: yes. |
es | string | en-US |
Body Parameters
None.
Response Information
Resource Description
Collection of DocumentManagementOutboundDetails| Name | Description | Type | Additional information |
|---|---|---|---|
| Location | string |
None. |
|
| DocumentUid | string |
None. |
|
| Title | string |
None. |
|
| InternalDocumentID | string |
None. |
|
| PrimaryFolder name | string |
None. |
|
| AdditionalDisplayFolders | string |
None. |
|
| Department | string |
None. |
|
| DocumentOwner | string |
None. |
|
| DocumentCoordinator | string |
None. |
|
| BusinessProcess | string |
None. |
|
| DocumentLevel | string |
None. |
|
| ApprovalWorkflow | string |
None. |
|
| Approvers | string |
None. |
|
| ApprovalTimeFrame | string |
None. |
|
| AutoReleaseDocument | string |
None. |
|
| PublishedFormat | string |
None. |
|
| UncontrolledDocument | string |
None. |
|
| DocumentView | string |
None. |
|
| PrivateViewers | string |
None. |
|
| Version | string |
None. |
|
| DocumentType | string |
None. |
|
| Description | string |
None. |
|
| KeyWords/Tags | string |
None. |
|
| ReferenceDocuments | Collection of ReferenceDocuments |
None. |
|
| RegulatoryReferences | string |
None. |
|
| PeriodicReviewFrequency | string |
None. |
|
| PeriodicReviewFrequencyUnit | string |
None. |
|
| PeriodicReviewStartDate | string |
None. |
|
| RetentionPeriod | string |
None. |
|
| RetentionPeriodUnit | string |
None. |
|
| ReleaseDate | string |
None. |
|
| Status | string |
None. |
|
| CreatedDate | string |
None. |
|
| CreatedBy | string |
None. |
|
| UpdatedDate | string |
None. |
|
| UpdatedBy | string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"Location": "sample string 1",
"DocumentUid": "sample string 4",
"Title": "sample string 5",
"InternalDocumentID": "sample string 6",
"PrimaryFolder name": "sample string 7",
"AdditionalDisplayFolders": "sample string 8",
"Department": "sample string 9",
"DocumentOwner ": "sample string 10",
"DocumentCoordinator": "sample string 11",
"BusinessProcess": "sample string 12",
"DocumentLevel ": "sample string 13",
"ApprovalWorkflow": "sample string 14",
"Approvers": "sample string 15",
"ApprovalTimeFrame ": "sample string 16",
"AutoReleaseDocument": "sample string 17",
"PublishedFormat": "sample string 18",
"UncontrolledDocument": "sample string 19",
"DocumentView": "sample string 20",
"PrivateViewers": "sample string 21",
"Version": "sample string 22",
"DocumentType": "sample string 23",
"Description": "sample string 24",
"KeyWords/Tags": "sample string 25",
"ReferenceDocuments": [
{
"Title": "sample string 3",
"InternalDocumentID": "sample string 4",
"PrimaryFolder": "sample string 5",
"Description": "sample string 6",
"Version": "sample string 7",
"Status ": "sample string 8"
},
{
"Title": "sample string 3",
"InternalDocumentID": "sample string 4",
"PrimaryFolder": "sample string 5",
"Description": "sample string 6",
"Version": "sample string 7",
"Status ": "sample string 8"
}
],
"RegulatoryReferences": "sample string 26",
"PeriodicReviewFrequency": "sample string 27",
"PeriodicReviewFrequencyUnit": "sample string 28",
"PeriodicReviewStartDate": "sample string 29",
"RetentionPeriod ": "sample string 30",
"RetentionPeriodUnit": "sample string 31",
"ReleaseDate": "sample string 32",
"Status ": "sample string 33",
"CreatedDate": "sample string 34",
"CreatedBy": "sample string 35",
"UpdatedDate": "sample string 36",
"UpdatedBy": "sample string 37"
},
{
"Location": "sample string 1",
"DocumentUid": "sample string 4",
"Title": "sample string 5",
"InternalDocumentID": "sample string 6",
"PrimaryFolder name": "sample string 7",
"AdditionalDisplayFolders": "sample string 8",
"Department": "sample string 9",
"DocumentOwner ": "sample string 10",
"DocumentCoordinator": "sample string 11",
"BusinessProcess": "sample string 12",
"DocumentLevel ": "sample string 13",
"ApprovalWorkflow": "sample string 14",
"Approvers": "sample string 15",
"ApprovalTimeFrame ": "sample string 16",
"AutoReleaseDocument": "sample string 17",
"PublishedFormat": "sample string 18",
"UncontrolledDocument": "sample string 19",
"DocumentView": "sample string 20",
"PrivateViewers": "sample string 21",
"Version": "sample string 22",
"DocumentType": "sample string 23",
"Description": "sample string 24",
"KeyWords/Tags": "sample string 25",
"ReferenceDocuments": [
{
"Title": "sample string 3",
"InternalDocumentID": "sample string 4",
"PrimaryFolder": "sample string 5",
"Description": "sample string 6",
"Version": "sample string 7",
"Status ": "sample string 8"
},
{
"Title": "sample string 3",
"InternalDocumentID": "sample string 4",
"PrimaryFolder": "sample string 5",
"Description": "sample string 6",
"Version": "sample string 7",
"Status ": "sample string 8"
}
],
"RegulatoryReferences": "sample string 26",
"PeriodicReviewFrequency": "sample string 27",
"PeriodicReviewFrequencyUnit": "sample string 28",
"PeriodicReviewStartDate": "sample string 29",
"RetentionPeriod ": "sample string 30",
"RetentionPeriodUnit": "sample string 31",
"ReleaseDate": "sample string 32",
"Status ": "sample string 33",
"CreatedDate": "sample string 34",
"CreatedBy": "sample string 35",
"UpdatedDate": "sample string 36",
"UpdatedBy": "sample string 37"
}
]
application/xml, text/xml
Sample:
<ArrayOfDocumentManagementOutboundDetails xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<DocumentManagementOutboundDetails>
<Location>sample string 1</Location>
<DocumentUid>sample string 4</DocumentUid>
<Title>sample string 5</Title>
<InternalDocumentID>sample string 6</InternalDocumentID>
<PrimaryFolder>sample string 7</PrimaryFolder>
<AdditionalDisplayFolders>sample string 8</AdditionalDisplayFolders>
<Department>sample string 9</Department>
<DocumentOwner>sample string 10</DocumentOwner>
<DocumentCoordinator>sample string 11</DocumentCoordinator>
<BusinessProcess>sample string 12</BusinessProcess>
<DocumentLevel>sample string 13</DocumentLevel>
<ApprovalWorkflow>sample string 14</ApprovalWorkflow>
<Approvers>sample string 15</Approvers>
<ApprovalTimeFrame>sample string 16</ApprovalTimeFrame>
<AutoReleaseDocument>sample string 17</AutoReleaseDocument>
<PublishedFormat>sample string 18</PublishedFormat>
<UncontrolledDocument>sample string 19</UncontrolledDocument>
<DocumentView>sample string 20</DocumentView>
<PrivateViewers>sample string 21</PrivateViewers>
<Version>sample string 22</Version>
<DocumentType>sample string 23</DocumentType>
<Description>sample string 24</Description>
<KeyWordsTags>sample string 25</KeyWordsTags>
<ReferenceDocuments>
<ReferenceDocuments>
<DocumentName>sample string 3</DocumentName>
<SourceDocumentID>sample string 4</SourceDocumentID>
<PrimaryFolder>sample string 5</PrimaryFolder>
<Description>sample string 6</Description>
<Version>sample string 7</Version>
<Status>sample string 8</Status>
</ReferenceDocuments>
<ReferenceDocuments>
<DocumentName>sample string 3</DocumentName>
<SourceDocumentID>sample string 4</SourceDocumentID>
<PrimaryFolder>sample string 5</PrimaryFolder>
<Description>sample string 6</Description>
<Version>sample string 7</Version>
<Status>sample string 8</Status>
</ReferenceDocuments>
</ReferenceDocuments>
<RegulatoryReferences>sample string 26</RegulatoryReferences>
<PeriodicReviewFrequency>sample string 27</PeriodicReviewFrequency>
<PeriodicReviewFrequencyUnit>sample string 28</PeriodicReviewFrequencyUnit>
<PeriodicReviewStartDate>sample string 29</PeriodicReviewStartDate>
<RetentionPeriod>sample string 30</RetentionPeriod>
<RetentionPeriodUnit>sample string 31</RetentionPeriodUnit>
<ReleaseDate>sample string 32</ReleaseDate>
<Status>sample string 33</Status>
<CreatedDate>sample string 34</CreatedDate>
<CreatedBy>sample string 35</CreatedBy>
<UpdatedDate>sample string 36</UpdatedDate>
<UpdatedBy>sample string 37</UpdatedBy>
</DocumentManagementOutboundDetails>
<DocumentManagementOutboundDetails>
<Location>sample string 1</Location>
<DocumentUid>sample string 4</DocumentUid>
<Title>sample string 5</Title>
<InternalDocumentID>sample string 6</InternalDocumentID>
<PrimaryFolder>sample string 7</PrimaryFolder>
<AdditionalDisplayFolders>sample string 8</AdditionalDisplayFolders>
<Department>sample string 9</Department>
<DocumentOwner>sample string 10</DocumentOwner>
<DocumentCoordinator>sample string 11</DocumentCoordinator>
<BusinessProcess>sample string 12</BusinessProcess>
<DocumentLevel>sample string 13</DocumentLevel>
<ApprovalWorkflow>sample string 14</ApprovalWorkflow>
<Approvers>sample string 15</Approvers>
<ApprovalTimeFrame>sample string 16</ApprovalTimeFrame>
<AutoReleaseDocument>sample string 17</AutoReleaseDocument>
<PublishedFormat>sample string 18</PublishedFormat>
<UncontrolledDocument>sample string 19</UncontrolledDocument>
<DocumentView>sample string 20</DocumentView>
<PrivateViewers>sample string 21</PrivateViewers>
<Version>sample string 22</Version>
<DocumentType>sample string 23</DocumentType>
<Description>sample string 24</Description>
<KeyWordsTags>sample string 25</KeyWordsTags>
<ReferenceDocuments>
<ReferenceDocuments>
<DocumentName>sample string 3</DocumentName>
<SourceDocumentID>sample string 4</SourceDocumentID>
<PrimaryFolder>sample string 5</PrimaryFolder>
<Description>sample string 6</Description>
<Version>sample string 7</Version>
<Status>sample string 8</Status>
</ReferenceDocuments>
<ReferenceDocuments>
<DocumentName>sample string 3</DocumentName>
<SourceDocumentID>sample string 4</SourceDocumentID>
<PrimaryFolder>sample string 5</PrimaryFolder>
<Description>sample string 6</Description>
<Version>sample string 7</Version>
<Status>sample string 8</Status>
</ReferenceDocuments>
</ReferenceDocuments>
<RegulatoryReferences>sample string 26</RegulatoryReferences>
<PeriodicReviewFrequency>sample string 27</PeriodicReviewFrequency>
<PeriodicReviewFrequencyUnit>sample string 28</PeriodicReviewFrequencyUnit>
<PeriodicReviewStartDate>sample string 29</PeriodicReviewStartDate>
<RetentionPeriod>sample string 30</RetentionPeriod>
<RetentionPeriodUnit>sample string 31</RetentionPeriodUnit>
<ReleaseDate>sample string 32</ReleaseDate>
<Status>sample string 33</Status>
<CreatedDate>sample string 34</CreatedDate>
<CreatedBy>sample string 35</CreatedBy>
<UpdatedDate>sample string 36</UpdatedDate>
<UpdatedBy>sample string 37</UpdatedBy>
</DocumentManagementOutboundDetails>
</ArrayOfDocumentManagementOutboundDetails>