POST api/External/{id}

Append logs to the document. If the update contains the status "Finished" or "Error" or "Disapproved" the status will be updated of the document.Finished: Marks the currect activity(archiving/sending/approval) as done.Error: Aborts the whole document process because the message could not be handled by the providerDisapproved: Aborts the whole document process because the message is not approved by the customerAuthorisation(s) : Portal application with an active usage entry in the tenant.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

document ID

globally unique identifier

Required

Body Parameters

new logs

UpdateStatusLog
NameDescriptionTypeAdditional information
Logs

Collection of StatusLogItem

Required

Min length: 1

Request Formats

application/json, text/json

Sample:
{
  "Logs": [
    {
      "Status": "In progress",
      "Description": null,
      "Timestamp": null
    },
    {
      "Status": "Finished",
      "Description": "Done with processing",
      "Timestamp": "2022-07-05T23:30:21.3443123Z"
    }
  ]
}

application/xml, text/xml

Sample:
<UpdateStatusLog xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MessageExpresse.Models">
  <Logs>
    <StatusLogItem>
      <Description i:nil="true" />
      <Status>In progress</Status>
      <Timestamp i:nil="true" />
    </StatusLogItem>
    <StatusLogItem>
      <Description>Done with processing</Description>
      <Status>Finished</Status>
      <Timestamp>2022-07-05T23:30:21.3443123Z</Timestamp>
    </StatusLogItem>
  </Logs>
</UpdateStatusLog>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.