GetDocumentObjects

The GetDocumentObjects API returns a list of document objects.

GET	`/docobj/list`
http://localhost/IDORequestService/ido/docobj/list?ido=UserNames

Parameters


Name	In	Required?	Description
ido	Query	No	The name of the IDO collection that contains the document objects
rowPointer	Query	No	The value of the IDO row pointer
docName	Query	No	The name of the document object to retrieve
docExt	Query	No	The file extension used for the document object to be retrieved
refSeq	Query	No	The reference sequence of the document object to retrieve

Headers


Name	Description
Authorization	If the API is called directly, then a Mongoose security token is obtained through a call to the GetSecurityToken API. If the API is called through ION API, then a valid OAuth2.0 bearer token is provided by ION API.
X-Infor-MongooseConfig	The name of a configuration that is available on the application server This header is required only when using the Mongoose API through the ION API.

Request data

None

Response data

{
  "Documents": [
   {
      "TableName": "Demo_Products",
      "TableRowPointer": "d629ebd6-974c-4969-be2e-145dd8d84da8",
      "DocumentName": "ultimate_choco_chip_cookies",
      "Description": null,
      "DocumentObject": "/9j/4AAQSkZJRgABAQAASABIAAD…Z",
      "DocumentExtension": "jpg",
      "MediaType": "image/jpeg",
      "RefSequence": "1",
      "_ItemId": "PBT=[DocumentObjectAndRefView] doc.ID=[0c4b201a-5ecd-4bf9-a242-86bf4c177727] doc.DT=[2018-10-12 09:52:12.153]"
   },
    {
      "TableName": "DemoSubmissionComments",
      "TableRowPointer": "67d4b6c8-3b67-4269-8f4f-7d7a7ee81f71",
      "DocumentName": "ayala_cinema_tickets_1508950029_6fccded3",
      "Description": null,
      "DocumentObject": "/9j/4AAQSkZJRgABAQAASABIAAD…Z",
      "DocumentExtension": "jpg",
      "MediaType": "image/jpeg",
      "RefSequence": "1",
      "_ItemId": "PBT=[DocumentObjectAndRefView] doc.ID=[d84729d2-8023-4624-8f02-5598def50073] doc.DT=[2018-10-12 10:07:34.433]"
    }
  ],
  "Success": true,
  "Message": null
}

Example

This example code retrieves a list of document objects attached to the UserNames IDO.

string json = string.Empty;
 
using ( HttpClient client = new HttpClient() )
{
   string ido = "UserNames";
   string requestUrl = $"http://server/IDORequestService/ido/docobj/list?ido={ido}";
 
   // provide token in the Authorization header
   client.DefaultRequestHeaders.TryAddWithoutValidation(
      "Authorization",
      "b/XdI6IQzCviZOGJ0E+002DoKUFOPmVDkwpQDbQj…==" );
   
   // send the get request
   HttpResponseMessage response = client.GetAsync( requestUrl ).Result;
 
   using ( HttpContent content = response.Content )
   {
      Task<string> result = content.ReadAsStringAsync();
      json = result.Result;
   }
}