POST Agents/Document/CheckinDocument

Some tooltip text!

• 2 minutes to read

 • 2 minutes to read

POST /api/v1/Agents/Document/CheckinDocument

Check in a currently checked-out document

Query String Parameters

Parameter Name	Type	Description
$select	string	Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.

POST /api/v1/Agents/Document/CheckinDocument?$select=name,department,category/id

Request Headers

Parameter Name	Description
Authorization	Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN	If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Content-Type	Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json
Accept	Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language	Convert string references and multi-language values into a specified language (iso2) code.
SO-Language	Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture	Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone	Specify the timezone code that you would like date/time responses converted to.
SO-AppToken	The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Request Body: request

DocumentId, AllowedReturnTypes, VersionDescription, VersionExtraFields

Property Name	Type	Description
DocumentId	Integer
AllowedReturnTypes	Array
VersionDescription	String
VersionExtraFields	Array

Response:

OK

Response	Description
200	OK

Response body: TimeZoneData

Property Name	Type	Description
ExternalReference	string
VersionId	string
Success	bool
Type	string
Value	string
AdditionalInfo	string

Sample request

POST /api/v1/Agents/Document/CheckinDocument
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: fr,de,ru,zh
Content-Type: application/json; charset=utf-8

{
  "DocumentId": 140,
  "AllowedReturnTypes": [
    "consequatur",
    "rerum"
  ],
  "VersionDescription": "Optimized grid-enabled hub",
  "VersionExtraFields": [
    "fuga",
    "rerum"
  ]
}

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "ExternalReference": "nesciunt",
  "VersionId": "cum",
  "Success": false,
  "Type": "CustomGui",
  "Value": "aut",
  "AdditionalInfo": "commodi"
}