Jump to

• Request
• Response

Update an Existing Instruction

put

/service/instruction/{id}

This endpoint is used to update an existing instruction.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• id(required): string
  key of the instruction Maintenance

Body ()

Request Body that contains data required for updating an existing instruction

Root Schema : LmmTmSweepInstructionDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object LmmTmSweepInstructionDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "instructionId":{
                    "type":"string",
                    "description":""
                },
                "instructionDescription":{
                    "type":"string",
                    "description":""
                },
                "productCode":{
                    "type":"string",
                    "description":""
                },
                "LmmTmSweepInstructionDetailsDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/LmmTmSweepInstructionDetailsDTO"
                    }
                }
            }
        }
    ]
}

Nested Schema : GenericDto

Match All

Show Source

• object GenericDto-allOf[0]
  Discriminator: resource_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : LmmTmSweepInstructionDTO-allOf[1]

Type: object

Show Source

• instructionDescription: string
• instructionId: string
• LmmTmSweepInstructionDetailsDTO: array LmmTmSweepInstructionDetailsDTO
• productCode: string

{
    "type":"object",
    "properties":{
        "instructionId":{
            "type":"string",
            "description":""
        },
        "instructionDescription":{
            "type":"string",
            "description":""
        },
        "productCode":{
            "type":"string",
            "description":""
        },
        "LmmTmSweepInstructionDetailsDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmmTmSweepInstructionDetailsDTO"
            }
        }
    }
}

Nested Schema : LmmTmSweepInstructionDetailsDTO

Type: array

Show Source

• Array of: object LmmTmSweepInstructionDetailsDTO

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LmmTmSweepInstructionDetailsDTO"
    }
}

Nested Schema : LmmTmSweepInstructionDetailsDTO

Type: object

Show Source

• id: string
• parameterName: string
• parameterValue: string
• sweepInstructionId: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":""
        },
        "sweepInstructionId":{
            "type":"string",
            "description":""
        },
        "parameterName":{
            "type":"string",
            "description":""
        },
        "parameterValue":{
            "type":"string",
            "description":""
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns updated instruction

Body ()

Root Schema : ResponseDtoWrapper

Type: object

Show Source

• data: object ResponseResourceSupport
• messages: object ResponseDto

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        },
        "data":{
            "$ref":"#/definitions/ResponseResourceSupport"
        }
    }
}

Nested Schema : ResponseResourceSupport

Type: object

Nested Schema : ResponseDto

Type: object

Show Source

• codes: array codes
• id: string
• requestId: string
• status: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "codes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string"
        }
    }
}

Nested Schema : codes

Type: array

Show Source

• Array of: object ResponseCode

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ResponseCode"
    }
}

Nested Schema : ResponseCode

Type: object

Show Source

• arg: string
• args: array args
• Code: string
• Desc: string
• Language: string
• Type: string

{
    "type":"object",
    "properties":{
        "Code":{
            "type":"string"
        },
        "Desc":{
            "type":"string"
        },
        "Type":{
            "type":"string"
        },
        "Language":{
            "type":"string"
        },
        "args":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string"
        }
    }
}

Nested Schema : args

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input

500 Response

Internal error

Back to Top