Jump to

• Request
• Response

Update an existing frequency

put

/frequency/{id}

This endpoint is used to update an existing frequency.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• id: string
  key of the frequency Maintenance

Body ()

Request Body that contains data required for updating an existing frequency

Root 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":""
                },
                "description":{
                    "type":"string",
                    "description":""
                },
                "expression":{
                    "type":"string",
                    "description":""
                },
                "frequencyType":{
                    "type":"string",
                    "description":""
                },
                "frequencyCategory":{
                    "type":"string",
                    "description":""
                },
                "isEod":{
                    "type":"string",
                    "description":""
                },
                "isBod":{
                    "type":"string",
                    "description":""
                }
            },
            "required":[
                "id",
                "frequencyId",
                "expression"
            ]
        }
    ]
}

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
• expression: string
• frequencyCategory(optional): string
• frequencyId: string
• frequencyType(optional): string
• isBod(optional): string
• isEod(optional): string

{
    "type":"object",
    "properties":{
        "frequencyId":{
            "type":"string",
            "description":""
        },
        "description":{
            "type":"string",
            "description":""
        },
        "expression":{
            "type":"string",
            "description":""
        },
        "frequencyType":{
            "type":"string",
            "description":""
        },
        "frequencyCategory":{
            "type":"string",
            "description":""
        },
        "isEod":{
            "type":"string",
            "description":""
        },
        "isBod":{
            "type":"string",
            "description":""
        }
    },
    "required":[
        "id",
        "frequencyId",
        "expression"
    ]
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns updated frequency

Body ()

Root Schema : ResponseDtoWrapper

Type: object

Show Source

• data(optional): object ResponseResourceSupport
• messages(optional): 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(optional): array codes
• id(optional): string
• requestId(optional): string
• status(optional): 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(optional): string
• args(optional): array args
• Code(optional): string
• Desc(optional): string
• Language(optional): string
• Type(optional): 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