Jump to

• Request
• Response

Retrieves the covenantmaintenance history by given ID

get

/api/1.0/covenantmaintenance/{id}/history

This operation retrives the covenant maintenance by ID using Covenant Maintenance Service.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• id: 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 covenantmaintenance based on given id.

Body ()

Root Schema : ClmoTmCovenantsCollection

Type: object

Collection of covenants.

Show Source

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

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

Nested Schema : data

Type: array

Show Source

• Array of: object ClmoTmCovenantsDTO

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

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

Nested 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"
        }
    }
}

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