POST api/services/v1/import/pid

Request Information

URI Parameters

None.

Body Parameters

PidImportInformationForApi
NameDescriptionTypeAdditional information
UseNestedFolderStructure

boolean

None.

ImportIds

Collection of string

None.

DataLocation

string

None.

Request Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/xml, text/xml

Sample:
<PidImportInformationForApi xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Andritz.AES.SPC.ImportTool.DataModels.JobInformation.ApiInformation">
  <DataLocation>sample string 2</DataLocation>
  <ImportIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ImportIds>
  <UseNestedFolderStructure>true</UseNestedFolderStructure>
</PidImportInformationForApi>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Dictionary of string [key] and JobInformationResponse [value]

Response Formats

application/json, text/json

Sample:
{
  "sample string 1": {
    "Message": "sample string 1",
    "TempTaskId": 1,
    "JobId": 3,
    "ProcessId": 4
  },
  "sample string 2": {
    "Message": "sample string 1",
    "TempTaskId": 1,
    "JobId": 3,
    "ProcessId": 4
  }
}

application/xml, text/xml

Sample:
<ArrayOfKeyValueOfstringJobInformationResponseJtbnDKQR xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <KeyValueOfstringJobInformationResponseJtbnDKQR>
    <Key>sample string 1</Key>
    <Value xmlns:d3p1="http://schemas.datacontract.org/2004/07/Andritz.AES.SPC.ImportTool.DataModels.JobInformation">
      <d3p1:JobId>3</d3p1:JobId>
      <d3p1:ProcessId>4</d3p1:ProcessId>
      <d3p1:TempTaskId>1</d3p1:TempTaskId>
      <d3p1:Message>sample string 1</d3p1:Message>
    </Value>
  </KeyValueOfstringJobInformationResponseJtbnDKQR>
  <KeyValueOfstringJobInformationResponseJtbnDKQR>
    <Key>sample string 2</Key>
    <Value xmlns:d3p1="http://schemas.datacontract.org/2004/07/Andritz.AES.SPC.ImportTool.DataModels.JobInformation">
      <d3p1:JobId>3</d3p1:JobId>
      <d3p1:ProcessId>4</d3p1:ProcessId>
      <d3p1:TempTaskId>1</d3p1:TempTaskId>
      <d3p1:Message>sample string 1</d3p1:Message>
    </Value>
  </KeyValueOfstringJobInformationResponseJtbnDKQR>
</ArrayOfKeyValueOfstringJobInformationResponseJtbnDKQR>