Previous Next JavaScript must be enabled to correctly display this content

## Retrieves the frequency by ID

get

/frequency/{id}

This endpoint is used to get the frequency by ID.

### Request

Supported Media Types

- application/json
- application/xml

Path Parameters

- id: string
  Id of the user that needs to be fetched

Query Parameters

- version(optional): string
  Id of the user that needs to be fetched

Back to Top

### Response

Supported Media Types

- application/json
- application/xml

#### 200 Response

Returns the frequency based on given id.
Body ()
Root Schema : LmmTmFrequencyWrapperDTO
Type: `object`
Show Source

- data(optional): object LmmTmFrequencyDTO

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

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

- allOf GenericDto
- object LmmTmFrequencyDTO-allOf[1]

    {
        "type":"object",
        "allOf":[
            {
                "$ref":"#/definitions/GenericDto"
            },
            {
                "type":"object",
                "properties":{
                    "frequencyId":{
                        "type":"string",
                        "description":"",
                        "minLength":1,
                        "maxLength":20,
                        "pattern":"([a-zA-Z0-9\\s]+)?"
                    },
                    "description":{
                        "type":"string",
                        "description":"",
                        "maxLength":100
                    },
                    "expression":{
                        "type":"string",
                        "description":"",
                        "maxLength":200
                    },
                    "frequencyType":{
                        "type":"string",
                        "description":"",
                        "maxLength":3,
                        "default":"C"
                    },
                    "frequencyCategory":{
                        "type":"string",
                        "description":"",
                        "maxLength":10
                    },
                    "isEod":{
                        "type":"string",
                        "description":"",
                        "maxLength":1,
                        "pattern":"[Y,N]"
                    },
                    "isBod":{
                        "type":"string",
                        "description":"",
                        "maxLength":1,
                        "pattern":"[Y,N]"
                    },
                    "isRepetitiveFrequency":{
                        "type":"string",
                        "description":"",
                        "maxLength":1,
                        "pattern":"[Y,N]"
                    },
                    "LmmTmFreqSweepCalDTO":{
                        "type":"array",
                        "items":{
                            "$ref":"#/definitions/LmmTmFreqSweepCalDTO"
                        }
                    }
                },
                "required":[
                    "id",
                    "frequencyId"
                ]
            }
        ]
    }

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 : LmmTmFrequencyDTO-allOf[1]
Type: `object`
Show Source

- description(optional): string
  Maximum Length: `100`
- expression(optional): string
  Maximum Length: `200`
- frequencyCategory(optional): string
  Maximum Length: `10`
- frequencyId: string
  Minimum Length: `1`
  Maximum Length: `20`
  Pattern: `([a-zA-Z0-9\s]+)?`
- frequencyType(optional): string
  Maximum Length: `3`
  Default Value: `C`
- isBod(optional): string
  Maximum Length: `1`
  Pattern: `[Y,N]`
- isEod(optional): string
  Maximum Length: `1`
  Pattern: `[Y,N]`
- isRepetitiveFrequency(optional): string
  Maximum Length: `1`
  Pattern: `[Y,N]`
- LmmTmFreqSweepCalDTO(optional): array LmmTmFreqSweepCalDTO

    {
        "type":"object",
        "properties":{
            "frequencyId":{
                "type":"string",
                "description":"",
                "minLength":1,
                "maxLength":20,
                "pattern":"([a-zA-Z0-9\\s]+)?"
            },
            "description":{
                "type":"string",
                "description":"",
                "maxLength":100
            },
            "expression":{
                "type":"string",
                "description":"",
                "maxLength":200
            },
            "frequencyType":{
                "type":"string",
                "description":"",
                "maxLength":3,
                "default":"C"
            },
            "frequencyCategory":{
                "type":"string",
                "description":"",
                "maxLength":10
            },
            "isEod":{
                "type":"string",
                "description":"",
                "maxLength":1,
                "pattern":"[Y,N]"
            },
            "isBod":{
                "type":"string",
                "description":"",
                "maxLength":1,
                "pattern":"[Y,N]"
            },
            "isRepetitiveFrequency":{
                "type":"string",
                "description":"",
                "maxLength":1,
                "pattern":"[Y,N]"
            },
            "LmmTmFreqSweepCalDTO":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LmmTmFreqSweepCalDTO"
                }
            }
        },
        "required":[
            "id",
            "frequencyId"
        ]
    }

Nested Schema : LmmTmFreqSweepCalDTO
Type: `array`
Show Source

- Array of: object LmmTmFreqSweepCalDTO

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

Nested Schema : LmmTmFreqSweepCalDTO
Type: `object`
Show Source

- executionDate: string
- frequencyId(optional): string
  Maximum Length: `36`
- id(optional): string
  Maximum Length: `36`

    {
        "type":"object",
        "properties":{
            "id":{
                "type":"string",
                "description":"",
                "maxLength":36
            },
            "frequencyId":{
                "type":"string",
                "description":"",
                "maxLength":36
            },
            "executionDate":{
                "type":"string",
                "description":""
            }
        },
        "required":[
            "executionDate"
        ]
    }

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