POST api/StorageObject/CreateDocument

creates document in ECS

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Guid		string	None.
CreateDocumentRequest		CreateDocumentRequest	Required
Vendor_Name	Vendor name in caps.	string	Required
Vendor_UserID	User ID of Vendor service account.	string	Required
Vendor_Password	Encrypted Password of vendor service account	string	Required

Request Formats

application/json, text/json, text/html

Sample:

{
  "Guid": "sample string 1",
  "CreateDocumentRequest": {
    "SystemId": 1,
    "BusinessAreaId": 2,
    "DocTypeId": 3,
    "AbbyyDocId": "sample string 4",
    "DocumentType": "sample string 5",
    "DocumentSource": 1,
    "BatchId": 6,
    "IndexFields": null,
    "DocumentStream": null,
    "DocumentName": "sample string 7",
    "IndexFieldValue": "sample string 8",
    "QueueID": 9,
    "QueueName": "sample string 10",
    "WorkItemTitle": "sample string 11",
    "WorkItemComment": "sample string 12",
    "WorkItemNote": "sample string 13",
    "SendToWorkFlow": true,
    "SendEmailNotification": true,
    "SendToNewBatch": true,
    "UserGpid": "sample string 17",
    "DocumentId": 18,
    "page": 19,
    "Filename": "sample string 20",
    "PODType": "sample string 21",
    "FilePath": "sample string 22",
    "RequesterUniqueId": "sample string 23",
    "SAPObjectId": "sample string 24",
    "ArchiveId": "sample string 25",
    "VendorName": "sample string 26"
  },
  "Vendor_Name": "sample string 2",
  "Vendor_UserID": "sample string 3",
  "Vendor_Password": "sample string 4"
}

application/xml, text/xml

Sample:

<CreateDocExtRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NextGen.Digital.Imaging.App.ExtGateway.Models">
  <Vendor_Name>sample string 2</Vendor_Name>
  <Vendor_Password>sample string 4</Vendor_Password>
  <Vendor_UserID>sample string 3</Vendor_UserID>
  <CreateDocumentRequest xmlns:d2p1="http://schemas.datacontract.org/2004/07/NextGen.Digital.Imaging.App.Gateway.EntityDataModels">
    <d2p1:AbbyyDocId>sample string 4</d2p1:AbbyyDocId>
    <d2p1:ArchiveId>sample string 25</d2p1:ArchiveId>
    <d2p1:BatchId>6</d2p1:BatchId>
    <d2p1:BusinessAreaId>2</d2p1:BusinessAreaId>
    <d2p1:DocTypeId>3</d2p1:DocTypeId>
    <d2p1:DocumentId>18</d2p1:DocumentId>
    <d2p1:DocumentName>sample string 7</d2p1:DocumentName>
    <d2p1:DocumentSource>Web_Upload</d2p1:DocumentSource>
    <d2p1:DocumentStream xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.IO" i:nil="true" />
    <d2p1:DocumentType>sample string 5</d2p1:DocumentType>
    <d2p1:FilePath>sample string 22</d2p1:FilePath>
    <d2p1:Filename>sample string 20</d2p1:Filename>
    <d2p1:IndexFieldValue>sample string 8</d2p1:IndexFieldValue>
    <d2p1:IndexFields i:nil="true" />
    <d2p1:PODType>sample string 21</d2p1:PODType>
    <d2p1:QueueID>9</d2p1:QueueID>
    <d2p1:QueueName>sample string 10</d2p1:QueueName>
    <d2p1:RequesterUniqueId>sample string 23</d2p1:RequesterUniqueId>
    <d2p1:SAPObjectId>sample string 24</d2p1:SAPObjectId>
    <d2p1:SendEmailNotification>true</d2p1:SendEmailNotification>
    <d2p1:SendToNewBatch>true</d2p1:SendToNewBatch>
    <d2p1:SendToWorkFlow>true</d2p1:SendToWorkFlow>
    <d2p1:SystemId>1</d2p1:SystemId>
    <d2p1:UserGpid>sample string 17</d2p1:UserGpid>
    <d2p1:VendorName>sample string 26</d2p1:VendorName>
    <d2p1:WorkItemComment>sample string 12</d2p1:WorkItemComment>
    <d2p1:WorkItemNote>sample string 13</d2p1:WorkItemNote>
    <d2p1:WorkItemTitle>sample string 11</d2p1:WorkItemTitle>
    <d2p1:page>19</d2p1:page>
  </CreateDocumentRequest>
  <Guid>sample string 1</Guid>
</CreateDocExtRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CreateDocExtRequest'.

multipart/form-data

Sample:

Failed to generate the sample for media type 'multipart/form-data'. Cannot use formatter 'DocumentCreationFormatter' to write type 'CreateDocExtRequest'.

application/octet-stream

Sample:

Failed to generate the sample for media type 'application/octet-stream'. Cannot use formatter 'DocumentCreationFormatter' to write type 'CreateDocExtRequest'.

Response Information

Resource Description

CreateDocResponseDto

Name	Type	Additional information
DocumentId	integer	None.
BatchId	integer	None.
WorkItemId	integer	None.
QueueName	string	None.
DocumentName	string	None.

Response Formats

application/json, text/json, text/html

Sample:

{
  "DocumentId": 1,
  "BatchId": 2,
  "WorkItemId": 3,
  "QueueName": "sample string 4",
  "DocumentName": "sample string 5"
}

application/xml, text/xml

Sample:

<CreateDocResponseDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NextGen.Digital.Imaging.App.Gateway.EntityDataModels">
  <BatchId>2</BatchId>
  <DocumentId>1</DocumentId>
  <DocumentName>sample string 5</DocumentName>
  <QueueName>sample string 4</QueueName>
  <WorkItemId>3</WorkItemId>
</CreateDocResponseDto>