Jump to

• Request
• Response

Adds a new Covenant Maintenance

post

/api/1.0/covenantmaintenance

This operation adds a new covenantmaintenance using Covenant Maintenance Service.

Request

Supported Media Types

• application/json
• application/xml

Body ()

Request Body that contains data required for creating a new covenantmaintenance

Root Schema : ClmoTmCovenantsDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object ClmoTmCovenantsDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "partyId":{
                    "type":"string",
                    "description":"partyId"
                },
                "partyName":{
                    "type":"string",
                    "description":"partyName"
                },
                "partyNumber":{
                    "type":"string",
                    "description":"partyNumber"
                },
                "projectName":{
                    "type":"string",
                    "description":"projectName",
                    "maxLength":105
                },
                "covenantsDetails":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/ClmoTmCovenantsDetailsDTO"
                    }
                }
            }
        }
    ]
}

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 : ClmoTmCovenantsDTO-allOf[1]

Type: object

Show Source

• covenantsDetails(optional): array covenantsDetails
• partyId(optional): string
  partyId
• partyName(optional): string
  partyName
• partyNumber(optional): string
  partyNumber
• projectName(optional): string
  Maximum Length: 105

  projectName

{
    "type":"object",
    "properties":{
        "partyId":{
            "type":"string",
            "description":"partyId"
        },
        "partyName":{
            "type":"string",
            "description":"partyName"
        },
        "partyNumber":{
            "type":"string",
            "description":"partyNumber"
        },
        "projectName":{
            "type":"string",
            "description":"projectName",
            "maxLength":105
        },
        "covenantsDetails":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ClmoTmCovenantsDetailsDTO"
            }
        }
    }
}

Nested Schema : covenantsDetails

Type: array

Show Source

• Array of: object ClmoTmCovenantsDetailsDTO

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

Nested Schema : ClmoTmCovenantsDetailsDTO

Type: object

Show Source

• covenantsId(optional): string
  covenantsId
• description(optional): string
  description
• dueBy(optional): string
  dueBy
• endBy(optional): string
  endBy
• frequency(optional): string
  frequency
• id(optional): string
  id
• name(optional): string
  name
• reminderDays(optional): number
  reminderDays
• status(optional): string
  status

{
    "type":"object",
    "properties":{
        "covenantsId":{
            "type":"string",
            "description":"covenantsId"
        },
        "description":{
            "type":"string",
            "description":"description"
        },
        "dueBy":{
            "type":"string",
            "description":"dueBy"
        },
        "endBy":{
            "type":"string",
            "description":"endBy"
        },
        "frequency":{
            "type":"string",
            "description":"frequency"
        },
        "id":{
            "type":"string",
            "description":"id"
        },
        "name":{
            "type":"string",
            "description":"name"
        },
        "reminderDays":{
            "type":"number",
            "description":"reminderDays"
        },
        "status":{
            "type":"string",
            "description":"status"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of succes or failure

Headers

• Location: string
  URL of newly created covenantmaintenance

Body ()

Root Schema : ResponseDtoWrapper

Type: object

Show Source

• data(optional): ResponseResourceSupport
• messages(optional): object ResponseDto
  ResponseDto model

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        },
        "data":{
            "$ref":"#/definitions/ResponseResourceSupport"
        }
    }
}

Nested Schema : ResponseResourceSupport

Match All

Show Source

• object ResponseResourceSupport-allOf[0]
  Discriminator: resouce_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resouce_type"
        }
    ]
}

Nested Schema : ResponseDto

Type: object

ResponseDto model

Show Source

• codes(optional): string
  Codes
• httpStatusCode(optional): array httpStatusCode
  Schedule Details
• keyId(optional): string
  KeyId
• overrideAuthLevelsReqd(optional): string
  OverrideAuthLevelsReqd
• requestId(optional): string
  RequestId
• status(optional): string
  Status

{
    "description":"ResponseDto model",
    "properties":{
        "keyId":{
            "description":"KeyId",
            "type":"string"
        },
        "status":{
            "description":"Status",
            "type":"string"
        },
        "codes":{
            "description":"Codes",
            "type":"string"
        },
        "httpStatusCode":{
            "type":"array",
            "description":"Schedule Details",
            "items":{
                "$ref":"#/definitions/responseCodes"
            }
        },
        "overrideAuthLevelsReqd":{
            "description":"OverrideAuthLevelsReqd",
            "type":"string"
        },
        "requestId":{
            "description":"RequestId",
            "type":"string"
        }
    }
}

Nested Schema : ResponseResourceSupport-allOf[0]

Type: object

Discriminator: resouce_type

Nested Schema : httpStatusCode

Type: array

Schedule Details

Show Source

• Array of: object responseCodes
  ResponseCodes

{
    "type":"array",
    "description":"Schedule Details",
    "items":{
        "$ref":"#/definitions/responseCodes"
    }
}

Nested Schema : responseCodes

Type: object

ResponseCodes

Show Source

• code(optional): string
  Code
• desc(optional): string
  Description
• error(optional): string
  Error
• info(optional): string
  Info
• language(optional): string
  Language
• override(optional): string
  Override
• type(optional): string
  Type

{
    "description":"ResponseCodes",
    "type":"object",
    "properties":{
        "code":{
            "description":"Code",
            "type":"string"
        },
        "desc":{
            "description":"Description",
            "type":"string"
        },
        "type":{
            "description":"Type",
            "type":"string"
        },
        "language":{
            "description":"Language",
            "type":"string"
        },
        "error":{
            "description":"Error",
            "type":"string"
        },
        "override":{
            "description":"Override",
            "type":"string"
        },
        "info":{
            "description":"Info",
            "type":"string"
        }
    }
}

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