Jump to

• Request
• Response

Get all Valid Instruction

get

/instruction

This endpoints will be used to get all valid instruction maintenance records.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• authStat(optional): string
• includecloseandunauth(optional): boolean
  includecloseandunauth need to be set to fetch summary record, defult value is false
• instructionDescription(optional): string
• instructionId(optional): string
• limit(optional): integer
  limit is maximum no of records to be fetched
• offset(optional): integer
  offset is starting no of records to be fetched
• productCode(optional): string
• recordStat(optional): string

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of succes or failure

Headers

• Location: string

Body ()

Root Schema : LmmTmSweepInstructionCollection

Type: object

Collection of sweepinstruction.

Show Source

• data(optional): array data
• paging(optional): object PagingDto

{
    "description":"Collection of sweepinstruction.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmmTmSweepInstructionDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object LmmTmSweepInstructionDTO

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        }
    }
}

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",
                    "minLength":1,
                    "maxLength":10,
                    "description":"",
                    "pattern":"[a-zA-Z0-9]{0,10}"
                },
                "instructionDescription":{
                    "type":"string",
                    "description":"",
                    "maxLength":100
                },
                "productCode":{
                    "type":"string",
                    "description":"",
                    "maxLength":10
                },
                "LmmTmSweepInstructionDetailsDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/LmmTmSweepInstructionDetailsDTO"
                    }
                }
            },
            "required":[
                "instructionId",
                "productCode"
            ]
        }
    ]
}

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(optional): string
  Maximum Length: 100
• instructionId: string
  Minimum Length: 1

  Maximum Length: 10

  Pattern: [a-zA-Z0-9]{0,10}
• LmmTmSweepInstructionDetailsDTO(optional): array LmmTmSweepInstructionDetailsDTO
• productCode: string
  Maximum Length: 10

{
    "type":"object",
    "properties":{
        "instructionId":{
            "type":"string",
            "minLength":1,
            "maxLength":10,
            "description":"",
            "pattern":"[a-zA-Z0-9]{0,10}"
        },
        "instructionDescription":{
            "type":"string",
            "description":"",
            "maxLength":100
        },
        "productCode":{
            "type":"string",
            "description":"",
            "maxLength":10
        },
        "LmmTmSweepInstructionDetailsDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmmTmSweepInstructionDetailsDTO"
            }
        }
    },
    "required":[
        "instructionId",
        "productCode"
    ]
}

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(optional): string
  Maximum Length: 36
• mandatory(optional): string
  Maximum Length: 1

  Pattern: [Y,N]
• parameterName(optional): string
  Maximum Length: 25
• parameterValue(optional): string
  Maximum Length: 100
• sweepInstructionId: string
  Maximum Length: 36

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "sweepInstructionId":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "parameterName":{
            "type":"string",
            "description":"",
            "maxLength":25
        },
        "parameterValue":{
            "type":"string",
            "description":"",
            "maxLength":100
        },
        "mandatory":{
            "type":"string",
            "description":"",
            "maxLength":1,
            "pattern":"[Y,N]"
        }
    },
    "required":[
        "sweepInstructionId"
    ]
}

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