Jump to

• Request
• Response

Update Existing Segment

put

/api/1.0/segment/{id}

This endpoint is used to update an existing Segment.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• id: string
  Key of the Segment Maintenance.

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.

Body ()

Request Body that contains data required for updating an existing Segment.

Root Schema : DmTmSegmentDTO

Type: object

Show Source

• DmTmStrategyDTO(optional): array DmTmStrategyDTO
• segmentCode(optional): string

{
    "type":"object",
    "properties":{
        "segmentCode":{
            "description":"",
            "type":"string"
        },
        "DmTmStrategyDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmTmStrategyDTO"
            }
        }
    }
}

Nested Schema : DmTmStrategyDTO

Type: array

Show Source

• Array of: object DmTmStrategyDTO

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

Nested Schema : DmTmStrategyDTO

Type: object

Show Source

• callDetails(optional): string
  Call Details
• enabledFlag(optional): string
  Enabled Flag
• strategyCode(optional): string
  Strategy Code
• userAssignmentCode(optional): string
  User Assignment Code

{
    "type":"object",
    "properties":{
        "strategyCode":{
            "description":"Strategy Code",
            "type":"string"
        },
        "userAssignmentCode":{
            "description":"User Assignment Code",
            "type":"string"
        },
        "callDetails":{
            "description":"Call Details",
            "type":"string"
        },
        "enabledFlag":{
            "description":"Enabled Flag",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns updated Segment

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