Jump to

• Request
• Response

Retrieves the instruction by ID

get

/service/lmc/instruction/{id}

This endpoint is used to retrieves the instruction by ID.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• id(required): string
  Id of the user that needs to be fetched

Query Parameters

• version: string
  Id of the user that needs to be fetched

Header Parameters

• sourceCode(required): string
  Source from which request is initiated

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns the instruction based on given id.

Body ()

Root Schema : LmmTmSweepInstructionWrapperServiceDTO

Type: object

Show Source

• data: object LmmTmSweepInstructionDTO

{
    "type":"object",
    "properties":{
        "data":{
            "$ref":"#/definitions/LmmTmSweepInstructionDTO"
        }
    }
}

Nested 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":""
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error

Back to Top