Jump to

• Request
• Response

Update Order Channel Parameters

post

/config/sim/v1/setup/updateorderchannelparameters

Updates the Order Channel Parameter. If Order Channel Parameter is not found, it creates a new Order Channel Parameter.

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-AuditTrailRef: string
  Detail that identifies, who made the change.

Body ()

Order Channel Parameters Request Body for Create and Update requests.

Root Schema : schema

Type: object

Show Source

• active: boolean
  A Boolean flag indicating the order channel is active

  Example: false
• hierUnitId(required): integer
  Unique hierarchy unit reference

  Example: 2
• objectNum(required): integer
  Unique reference of the Order Channel Parameter

  Example: 2
• options: string
  A string value of 0s & 1s of length 32 representing enabled or disabled options

  Example: 00000000000000000000000000000000
• orderChannelId(required): integer
  Unique reference of the Order Channel

  Example: 1
• orderDeviceMask: string
  A string value of 0s & 1s of length 32 representing the enablement or disablement of the order device mask associated with the Order Channel parameter

  Example: 00000000000000000000000000000000

{
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum",
        "orderChannelId"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":2,
            "description":"Unique hierarchy unit reference"
        },
        "objectNum":{
            "type":"integer",
            "example":2,
            "description":"Unique reference of the Order Channel Parameter"
        },
        "orderChannelId":{
            "type":"integer",
            "example":1,
            "description":"Unique reference of the Order Channel"
        },
        "options":{
            "type":"string",
            "example":"00000000000000000000000000000000",
            "description":"A string value of 0s & 1s of length 32 representing enabled or disabled options"
        },
        "active":{
            "type":"boolean",
            "example":false,
            "description":"A Boolean flag indicating the order channel is active"
        },
        "orderDeviceMask":{
            "type":"string",
            "example":"00000000000000000000000000000000",
            "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the order device mask associated with the Order Channel parameter"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Order channel parameters Updated or Added.

Body ()

Root Schema : OrderChannelParameterCUResponse

Type: object

Show Source

• hierUnitId: integer
  Unique hierarchy unit value

  Example: 1
• objectNum: integer
  Unique reference of the Order Channel Parameter

  Example: 2

{
    "type":"object",
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":1,
            "description":"Unique hierarchy unit value"
        },
        "objectNum":{
            "type":"integer",
            "example":2,
            "description":"Unique reference of the Order Channel Parameter"
        }
    }
}

Back to Top