POST api/StorageObject/UpdateDocument

Updates document and its indexing fields

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
updateDocument		UpdateDocument	None.
podType		string	None.
guid		string	None.
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:

{
  "updateDocument": {
    "UserGpid": "sample string 1",
    "SystemId": 2,
    "DocumentId": 3,
    "workitemHistory": {
      "UserGpid": "sample string 1",
      "systemId": 2,
      "IvDocId": 3,
      "WIId": 4,
      "WICreationDate": "sample string 5",
      "WITitle": "sample string 6",
      "WIActionDate": "sample string 7",
      "WIActionTime": "sample string 8",
      "WIFromQueue": "sample string 9",
      "WIToQueue": "sample string 10",
      "WIActionUser": "sample string 11",
      "WICurrentUser": "sample string 12",
      "WIActionStatus": "sample string 13",
      "WICurrentStatus": "sample string 14",
      "WINotes": "sample string 15"
    },
    "IndexFields": null,
    "clipID": "sample string 4",
    "DocumentStream": null,
    "FileName": "sample string 5",
    "PodType": "sample string 6"
  },
  "podType": "sample string 1",
  "guid": "sample string 2",
  "Vendor_Name": "sample string 3",
  "Vendor_UserID": "sample string 4",
  "Vendor_Password": "sample string 5"
}

application/xml, text/xml

Sample:

<UpdateDocumentExtRequest 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 3</Vendor_Name>
  <Vendor_Password>sample string 5</Vendor_Password>
  <Vendor_UserID>sample string 4</Vendor_UserID>
  <guid>sample string 2</guid>
  <podType>sample string 1</podType>
  <updateDocument xmlns:d2p1="http://schemas.datacontract.org/2004/07/NextGen.Digital.Imaging.App.Gateway.EntityDataModels">
    <d2p1:DocumentId>3</d2p1:DocumentId>
    <d2p1:DocumentStream xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.IO" i:nil="true" />
    <d2p1:FileName>sample string 5</d2p1:FileName>
    <d2p1:IndexFields i:nil="true" />
    <d2p1:PodType>sample string 6</d2p1:PodType>
    <d2p1:SystemId>2</d2p1:SystemId>
    <d2p1:UserGpid>sample string 1</d2p1:UserGpid>
    <d2p1:clipID>sample string 4</d2p1:clipID>
    <d2p1:workitemHistory>
      <d2p1:IvDocId>3</d2p1:IvDocId>
      <d2p1:UserGpid>sample string 1</d2p1:UserGpid>
      <d2p1:WIActionDate>sample string 7</d2p1:WIActionDate>
      <d2p1:WIActionStatus>sample string 13</d2p1:WIActionStatus>
      <d2p1:WIActionTime>sample string 8</d2p1:WIActionTime>
      <d2p1:WIActionUser>sample string 11</d2p1:WIActionUser>
      <d2p1:WICreationDate>sample string 5</d2p1:WICreationDate>
      <d2p1:WICurrentStatus>sample string 14</d2p1:WICurrentStatus>
      <d2p1:WICurrentUser>sample string 12</d2p1:WICurrentUser>
      <d2p1:WIFromQueue>sample string 9</d2p1:WIFromQueue>
      <d2p1:WIId>4</d2p1:WIId>
      <d2p1:WINotes>sample string 15</d2p1:WINotes>
      <d2p1:WITitle>sample string 6</d2p1:WITitle>
      <d2p1:WIToQueue>sample string 10</d2p1:WIToQueue>
      <d2p1:systemId>2</d2p1:systemId>
    </d2p1:workitemHistory>
  </updateDocument>
</UpdateDocumentExtRequest>

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 'UpdateDocumentExtRequest'.

multipart/form-data

Sample:

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

application/octet-stream

Sample:

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

Response Information

Resource Description

boolean

Response Formats

application/json, text/json, text/html

Sample:

true

application/xml, text/xml

Sample:

<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>