POST RequestModelsPollingAPI
Request Information
URI Parameters
None.
Body Parameters
InputDataName | Description | Type | Additional information |
---|---|---|---|
Id | integer |
None. |
|
PartId | string |
Required String length: inclusive between 0 and 8000 |
|
DomainName | string |
Required String length: inclusive between 0 and 8000 |
|
PartNumber | string |
None. |
|
Parameters | Collection of Parameter |
None. |
|
OutputFormat | string |
Required String length: inclusive between 0 and 8000 |
|
UID | string |
Required String length: inclusive between 0 and 8000 |
|
RequestId | string |
String length: inclusive between 0 and 8000 |
|
IsDebugMode | boolean |
None. |
|
ApplicationPath | string |
String length: inclusive between 0 and 8000 |
|
IsVersion2 | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{ "Id": 1, "PartId": "sample string 2", "DomainName": "sample string 3", "PartNumber": "sample string 4", "Parameters": [ { "Id": 1, "Name": "sample string 2", "Value": "sample string 3", "ParamType": "sample string 4", "Prefix": "sample string 5", "Label": "sample string 6", "Min": 1.0, "Max": 1.0, "Offset": 1.0, "IsMandatory": true, "IsParent": true, "DisplayOrder": 9, "PartNumberOrder": 1, "ImageExist": true, "ModelParamValues": [ { "Id": 1, "ParameterId": 1, "Value": "sample string 1", "Label": "sample string 2", "IsDefault": true, "Path": "sample string 4", "Prefix": "sample string 5", "PartNumber": "sample string 6" }, { "Id": 1, "ParameterId": 1, "Value": "sample string 1", "Label": "sample string 2", "IsDefault": true, "Path": "sample string 4", "Prefix": "sample string 5", "PartNumber": "sample string 6" } ], "RuleFunction": [ "sample string 1", "sample string 2" ] }, { "Id": 1, "Name": "sample string 2", "Value": "sample string 3", "ParamType": "sample string 4", "Prefix": "sample string 5", "Label": "sample string 6", "Min": 1.0, "Max": 1.0, "Offset": 1.0, "IsMandatory": true, "IsParent": true, "DisplayOrder": 9, "PartNumberOrder": 1, "ImageExist": true, "ModelParamValues": [ { "Id": 1, "ParameterId": 1, "Value": "sample string 1", "Label": "sample string 2", "IsDefault": true, "Path": "sample string 4", "Prefix": "sample string 5", "PartNumber": "sample string 6" }, { "Id": 1, "ParameterId": 1, "Value": "sample string 1", "Label": "sample string 2", "IsDefault": true, "Path": "sample string 4", "Prefix": "sample string 5", "PartNumber": "sample string 6" } ], "RuleFunction": [ "sample string 1", "sample string 2" ] } ], "OutputFormat": "sample string 5", "UID": "sample string 6", "RequestId": "sample string 7", "IsDebugMode": true, "ApplicationPath": "sample string 9", "IsVersion2": true }
application/xml, text/xml
Sample:
<InputData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Models"> <ApplicationPath>sample string 9</ApplicationPath> <DomainName>sample string 3</DomainName> <Id>1</Id> <IsDebugMode>true</IsDebugMode> <IsVersion2>true</IsVersion2> <OutputFormat>sample string 5</OutputFormat> <Parameters> <Parameter> <DisplayOrder>9</DisplayOrder> <Id>1</Id> <ImageExist>true</ImageExist> <IsMandatory>true</IsMandatory> <IsParent>true</IsParent> <Label>sample string 6</Label> <Max>1</Max> <Min>1</Min> <ModelParamValues> <ModelParamValues> <Id>1</Id> <IsDefault>true</IsDefault> <Label>sample string 2</Label> <ParameterId>1</ParameterId> <PartNumber>sample string 6</PartNumber> <Path>sample string 4</Path> <Prefix>sample string 5</Prefix> <Value>sample string 1</Value> </ModelParamValues> <ModelParamValues> <Id>1</Id> <IsDefault>true</IsDefault> <Label>sample string 2</Label> <ParameterId>1</ParameterId> <PartNumber>sample string 6</PartNumber> <Path>sample string 4</Path> <Prefix>sample string 5</Prefix> <Value>sample string 1</Value> </ModelParamValues> </ModelParamValues> <Name>sample string 2</Name> <Offset>1</Offset> <ParamType>sample string 4</ParamType> <PartNumberOrder>1</PartNumberOrder> <Prefix>sample string 5</Prefix> <RuleFunction xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </RuleFunction> <Value>sample string 3</Value> </Parameter> <Parameter> <DisplayOrder>9</DisplayOrder> <Id>1</Id> <ImageExist>true</ImageExist> <IsMandatory>true</IsMandatory> <IsParent>true</IsParent> <Label>sample string 6</Label> <Max>1</Max> <Min>1</Min> <ModelParamValues> <ModelParamValues> <Id>1</Id> <IsDefault>true</IsDefault> <Label>sample string 2</Label> <ParameterId>1</ParameterId> <PartNumber>sample string 6</PartNumber> <Path>sample string 4</Path> <Prefix>sample string 5</Prefix> <Value>sample string 1</Value> </ModelParamValues> <ModelParamValues> <Id>1</Id> <IsDefault>true</IsDefault> <Label>sample string 2</Label> <ParameterId>1</ParameterId> <PartNumber>sample string 6</PartNumber> <Path>sample string 4</Path> <Prefix>sample string 5</Prefix> <Value>sample string 1</Value> </ModelParamValues> </ModelParamValues> <Name>sample string 2</Name> <Offset>1</Offset> <ParamType>sample string 4</ParamType> <PartNumberOrder>1</PartNumberOrder> <Prefix>sample string 5</Prefix> <RuleFunction xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </RuleFunction> <Value>sample string 3</Value> </Parameter> </Parameters> <PartId>sample string 2</PartId> <PartNumber>sample string 4</PartNumber> <RequestId>sample string 7</RequestId> <UID>sample string 6</UID> </InputData>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
ReportStatusName | Description | Type | Additional information |
---|---|---|---|
Status | string |
None. |
|
StatusCode | integer |
None. |
|
PartNumber | string |
None. |
|
FileType | string |
None. |
|
PartId | string |
None. |
|
Message | Object |
None. |
Response Formats
application/json, text/json
Sample:
{ "Status": "sample string 1", "StatusCode": 2, "PartNumber": "sample string 3", "FileType": "sample string 4", "PartId": "sample string 5", "Message": {} }
application/xml, text/xml
Sample:
<ReportStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Models"> <FileType>sample string 4</FileType> <Message /> <PartId>sample string 5</PartId> <PartNumber>sample string 3</PartNumber> <Status>sample string 1</Status> <StatusCode>2</StatusCode> </ReportStatus>