Jump to

• Request
• Response

Retrieve the Strategy by ID

get

/api/1.0/strategymaintenance/{id}

This endpoint is used to retrieve the Strategy 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: string
  Id of the user that needs to be fetched

Header Parameters

• appId: string
  The application ID of host service.
• branchCode: string
  The branch code of requesting branch.
• contentType(optional): string
  The content type of request or response body.
• userId: string
  The user ID of requesting user.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns the Strategy based on given ID.

Body ()

Root Schema : DmTmStrategymaintenanceWrapperDTO

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "data":{
            "$ref":"#/definitions/DmTmStrategymaintenanceDTO"
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : DmTmStrategymaintenanceDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object DmTmStrategymaintenanceDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "code":{
                    "description":"Code",
                    "type":"string"
                },
                "description":{
                    "description":"Description",
                    "type":"string"
                },
                "effectiveDate":{
                    "description":"Effective date",
                    "type":"string"
                },
                "expiryDate":{
                    "description":"Expiry date",
                    "type":"string"
                },
                "DmTmTaskDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/DmTmTaskDTO"
                    }
                }
            }
        }
    ]
}

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

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

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

Type: object

Show Source

• code(optional): string
  Code
• description(optional): string
  Description
• DmTmTaskDTO(optional): array DmTmTaskDTO
• effectiveDate(optional): string
  Effective date
• expiryDate(optional): string
  Expiry date

{
    "type":"object",
    "properties":{
        "code":{
            "description":"Code",
            "type":"string"
        },
        "description":{
            "description":"Description",
            "type":"string"
        },
        "effectiveDate":{
            "description":"Effective date",
            "type":"string"
        },
        "expiryDate":{
            "description":"Expiry date",
            "type":"string"
        },
        "DmTmTaskDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmTmTaskDTO"
            }
        }
    }
}

Nested Schema : DmTmTaskDTO

Type: array

Show Source

• Array of: object DmTmTaskDTO

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

Nested Schema : DmTmTaskDTO

Type: object

Show Source

• dependency(optional): string
  Dependency
• DmTmAdviceDTO(optional): array DmTmAdviceDTO
• escalation(optional): string
  Escalation
• expiration(optional): string
  Expiration
• id(optional): string
  ID
• mandatory(optional): boolean
  Mandatory
• sequence(optional): integer
  Sequence
• strategymaintenanceMasterId(optional): string
  Strategy maintenance master ID
• taskName(optional): string
  Task name
• waitPeriod(optional): string
  Wait Period

{
    "type":"object",
    "properties":{
        "sequence":{
            "description":"Sequence",
            "type":"integer"
        },
        "taskName":{
            "description":"Task name",
            "type":"string"
        },
        "mandatory":{
            "description":"Mandatory",
            "type":"boolean"
        },
        "waitPeriod":{
            "description":"Wait Period",
            "type":"string"
        },
        "escalation":{
            "description":"Escalation",
            "type":"string"
        },
        "expiration":{
            "description":"Expiration",
            "type":"string"
        },
        "dependency":{
            "description":"Dependency",
            "type":"string"
        },
        "id":{
            "type":"string",
            "description":"ID"
        },
        "strategymaintenanceMasterId":{
            "type":"string",
            "description":"Strategy maintenance master ID"
        },
        "DmTmAdviceDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmTmAdviceDTO"
            }
        }
    }
}

Nested Schema : DmTmAdviceDTO

Type: array

Show Source

• Array of: object DmTmAdviceDTO

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

Nested Schema : DmTmAdviceDTO

Type: object

Show Source

• code(optional): string
• default(optional): boolean
  Default
• description(optional): string
• id(optional): string
  ID
• selected(optional): boolean
• TaskMasterId(optional): string
  Task master ID

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "selected":{
            "type":"boolean"
        },
        "default":{
            "type":"boolean",
            "description":"Default"
        },
        "id":{
            "type":"string",
            "description":"ID"
        },
        "TaskMasterId":{
            "type":"string",
            "description":"Task master ID"
        }
    }
}

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