POST api/Specification/CreateSpecificationListing

Creates the specification listing. Required fields (Unique ListingName, SpecificationId)

Access

Requires authentication.

Requires SSL.

Request Information

Parameters

NameDescriptionAdditional information
specificationListing
The specification listing.

Define this parameter in the request body.

Request body formats

application/xml, text/xml

Sample:
<SpecificationListing xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Id>1</Id>
  <Readonly>true</Readonly>
  <SpecificationId>1</SpecificationId>
  <LineIndex>1</LineIndex>
  <ListingName>sample string 1</ListingName>
  <FirstLabelColorId>1</FirstLabelColorId>
  <SecondLabelColorId>1</SecondLabelColorId>
  <ObjectDescription1>sample string 2</ObjectDescription1>
  <ObjectDescription2>sample string 3</ObjectDescription2>
  <TaskReferenceNumber>sample string 4</TaskReferenceNumber>
  <Blueprint>sample string 5</Blueprint>
  <RowRevisionDate>2024-05-21T01:08:07.3458723+02:00</RowRevisionDate>
</SpecificationListing>

application/json, text/json

Sample:
{
  "SpecificationId": 1,
  "LineIndex": 1,
  "ListingName": "sample string 1",
  "FirstLabelColorId": 1,
  "SecondLabelColorId": 1,
  "ObjectDescription1": "sample string 2",
  "ObjectDescription2": "sample string 3",
  "TaskReferenceNumber": "sample string 4",
  "Blueprint": "sample string 5",
  "RowRevisionDate": "2024-05-21T01:08:07.3458723+02:00",
  "Id": 1,
  "Readonly": true
}

Response Information

Response body formats

application/xml, text/xml

Sample:
<ApiResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ResponseCode>1</ResponseCode>
  <ResponseDescription>sample string 2</ResponseDescription>
  <MethodExpirationDate>2024-05-21T01:08:07.3538688+02:00</MethodExpirationDate>
  <ResponseObject>
    <ModelId>1</ModelId>
    <ModelGUID>sample string 1</ModelGUID>
  </ResponseObject>
</ApiResponse>

application/json, text/json

Sample:
{
  "ResponseCode": 1,
  "ResponseDescription": "sample string 2",
  "MethodExpirationDate": "2024-05-21T01:08:07.3538688+02:00",
  "ResponseObject": {
    "ModelId": 1,
    "ModelGUID": "sample string 1"
  }
}