Previous Next JavaScript must be enabled to correctly display this content

## Get all Valid Sweep Products

get

/service/lmc/sweepproducts

This endpoint is used to get all valid Sweep Products maintenance records.

### Request

Supported Media Types

- application/json
- application/xml

Query Parameters

- 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
- productDescription(optional): string

Back to Top

### Response

Supported Media Types

- application/json
- application/xml

#### 201 Response

Returns message of success or failure
Headers

- Location: string

Body ()
Root Schema : LmmTmSweepProductsServiceCollection
Type: `object`
Collection of sweepproducts.
Show Source

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

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

Nested Schema : data
Type: `array`
Show Source

- Array of: object LmmTmSweepProductsDTO

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

Nested Schema : PagingDto
Type: `object`
Show Source

- totalResults(optional): integer

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

Nested Schema : LmmTmSweepProductsDTO
Type: `object`
Match All
Show Source

- allOf GenericDto
- object LmmTmSweepProductsDTO-allOf[1]

    {
        "type":"object",
        "allOf":[
            {
                "$ref":"#/definitions/GenericDto"
            },
            {
                "type":"object",
                "properties":{
                    "productCode":{
                        "type":"string",
                        "description":""
                    },
                    "productDescription":{
                        "type":"string",
                        "description":""
                    },
                    "LmmTmSweepProductDetailsDTO":{
                        "type":"array",
                        "items":{
                            "$ref":"#/definitions/LmmTmSweepProductDetailsDTO"
                        }
                    }
                },
                "required":[
                    "id",
                    "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 : LmmTmSweepProductsDTO-allOf[1]
Type: `object`
Show Source

- LmmTmSweepProductDetailsDTO(optional): array LmmTmSweepProductDetailsDTO
- productCode: string
- productDescription(optional): string

    {
        "type":"object",
        "properties":{
            "productCode":{
                "type":"string",
                "description":""
            },
            "productDescription":{
                "type":"string",
                "description":""
            },
            "LmmTmSweepProductDetailsDTO":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LmmTmSweepProductDetailsDTO"
                }
            }
        },
        "required":[
            "id",
            "productCode"
        ]
    }

Nested Schema : LmmTmSweepProductDetailsDTO
Type: `array`
Show Source

- Array of: object LmmTmSweepProductDetailsDTO

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

Nested Schema : LmmTmSweepProductDetailsDTO
Type: `object`
Show Source

- id(optional): string
- mandatory(optional): string
- parameterName(optional): string
- parameterType(optional): string
- sweepProductId: string

    {
        "type":"object",
        "properties":{
            "id":{
                "type":"string",
                "description":""
            },
            "sweepProductId":{
                "type":"string",
                "description":""
            },
            "parameterName":{
                "type":"string",
                "description":""
            },
            "parameterType":{
                "type":"string",
                "description":""
            },
            "mandatory":{
                "type":"string",
                "description":""
            }
        },
        "required":[
            "sweepProductId"
        ]
    }

#### 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