POST api/v1/lpa/documents/hierarchy/trace

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
docId		string	None.
traceType		string	None.

Request Formats

application/json, text/json

Sample:

{
  "docId": "sample string 1",
  "traceType": "sample string 2"
}

application/xml, text/xml

Sample:

<DocTraceRequestMDL xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FTSMDLClassLibrary.WebAPIMDL.LPA">
  <docId>sample string 1</docId>
  <traceType>sample string 2</traceType>
</DocTraceRequestMDL>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

DocTraceResponseMDL

Name	Type	Additional information
response	integer	None.
status	string	None.
message	string	None.
trace_type	string	None.
requested	RequestedDocumentMDL	None.
upstream	Collection of DocumentNodeMDL	None.
downstream	Collection of DocumentNodeMDL	None.

Response Formats

application/json, text/json

Sample:

{
  "response": 1,
  "status": "sample string 2",
  "message": "sample string 3",
  "trace_type": "sample string 4",
  "requested": {
    "doc_id": "sample string 1",
    "doc_type": "sample string 2",
    "customFields": {}
  },
  "upstream": [
    {
      "doc_id": "sample string 1",
      "doc_type": "sample string 2",
      "level": 3,
      "customFields": {}
    },
    {
      "doc_id": "sample string 1",
      "doc_type": "sample string 2",
      "level": 3,
      "customFields": {}
    }
  ],
  "downstream": [
    {
      "doc_id": "sample string 1",
      "doc_type": "sample string 2",
      "level": 3,
      "customFields": {}
    },
    {
      "doc_id": "sample string 1",
      "doc_type": "sample string 2",
      "level": 3,
      "customFields": {}
    }
  ]
}

application/xml, text/xml

Sample:

<DocTraceResponseMDL xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FTSMDLClassLibrary.WebAPIMDL.LPA">
  <downstream>
    <DocumentNodeMDL>
      <customFields />
      <doc_id>sample string 1</doc_id>
      <doc_type>sample string 2</doc_type>
      <level>3</level>
    </DocumentNodeMDL>
    <DocumentNodeMDL>
      <customFields />
      <doc_id>sample string 1</doc_id>
      <doc_type>sample string 2</doc_type>
      <level>3</level>
    </DocumentNodeMDL>
  </downstream>
  <message>sample string 3</message>
  <requested>
    <customFields />
    <doc_id>sample string 1</doc_id>
    <doc_type>sample string 2</doc_type>
  </requested>
  <response>1</response>
  <status>sample string 2</status>
  <trace_type>sample string 4</trace_type>
  <upstream>
    <DocumentNodeMDL>
      <customFields />
      <doc_id>sample string 1</doc_id>
      <doc_type>sample string 2</doc_type>
      <level>3</level>
    </DocumentNodeMDL>
    <DocumentNodeMDL>
      <customFields />
      <doc_id>sample string 1</doc_id>
      <doc_type>sample string 2</doc_type>
      <level>3</level>
    </DocumentNodeMDL>
  </upstream>
</DocTraceResponseMDL>