Jump to

• Request
• Response

Get All Valid Identifier Definition

get

/obedm-common-services/identifierdefinition

This endpoint is used to Get all valid Identifier Definition maintenance records.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• authStat(optional): string
  Authorised Status that needs to be fetched.
• branch(optional): string
  Branch that needs to be fetched.
• entityTypeCd(optional): string
  Entity Type Code that needs to be fetched.
• includecloseandunauth(optional): boolean
  Include close and unauthorised need to be set to fetch summary record, default value is false.
• limit(optional): integer
  Limit is maximum number of records to be fetched.
• offset(optional): integer
  Offset is starting number of records to be fetched.
• productProcessor(optional): string
  Product Processor that needs to be fetched.
• recordStat(optional): string
  Record Status that needs to be fetched.

Header Parameters

• appId: string
  The ID of the Application.
• branchCode: string
  The branch code associated with the request.
• contentType(optional): string
  The Content Type of the request.
• tenantId(optional): string
  The ID of the Tenant.
• userId: string
  The ID of the User.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of success or failure.

Headers

• Location: string
  Header of Response

Body ()

Root Schema : DmTmIdentifierDefinitionCollection

Type: object

Collection of identifier definition.

Show Source

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

{
    "description":"Collection of identifier definition.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmTmIdentifierDefinitionDTO",
                "description":"List of identifier definitions."
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object DmTmIdentifierDefinitionDTO

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DmTmIdentifierDefinitionDTO",
        "description":"List of identifier definitions."
    }
}

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

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

Nested Schema : DmTmIdentifierDefinitionDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object DmTmIdentifierDefinitionDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "productProcessor":{
                    "description":"The product processor for the entity.",
                    "type":"string"
                },
                "entityTypeCd":{
                    "description":"The entity type code.",
                    "type":"string"
                },
                "branch":{
                    "description":"The branch code associated with the entity.",
                    "type":"string"
                },
                "maxLength":{
                    "description":"The maximum length of the entity.",
                    "type":"integer"
                },
                "fixedLength":{
                    "description":"Whether the entity has a fixed length.",
                    "type":"boolean"
                },
                "checkSum":{
                    "description":"Whether the entity has a checksum.",
                    "type":"boolean"
                },
                "userSeqResetFreqCd":{
                    "description":"The reset frequency for the user sequence.",
                    "type":"string"
                },
                "systemSeqName":{
                    "description":"The system sequence name",
                    "type":"string",
                    "maxLength":30
                },
                "DmTmIdentifierParametersDTO":{
                    "description":"An array of Identifier Parameters DTO objects.",
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/DmTmIdentifierParametersDTO"
                    }
                }
            }
        }
    ]
}

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

Type: object

Show Source

• branch(optional): string
  The branch code associated with the entity.
• checkSum(optional): boolean
  Whether the entity has a checksum.
• DmTmIdentifierParametersDTO(optional): array DmTmIdentifierParametersDTO
  An array of Identifier Parameters DTO objects.
• entityTypeCd(optional): string
  The entity type code.
• fixedLength(optional): boolean
  Whether the entity has a fixed length.
• maxLength(optional): integer
  The maximum length of the entity.
• productProcessor(optional): string
  The product processor for the entity.
• systemSeqName(optional): string
  Maximum Length: 30

  The system sequence name
• userSeqResetFreqCd(optional): string
  The reset frequency for the user sequence.

{
    "type":"object",
    "properties":{
        "productProcessor":{
            "description":"The product processor for the entity.",
            "type":"string"
        },
        "entityTypeCd":{
            "description":"The entity type code.",
            "type":"string"
        },
        "branch":{
            "description":"The branch code associated with the entity.",
            "type":"string"
        },
        "maxLength":{
            "description":"The maximum length of the entity.",
            "type":"integer"
        },
        "fixedLength":{
            "description":"Whether the entity has a fixed length.",
            "type":"boolean"
        },
        "checkSum":{
            "description":"Whether the entity has a checksum.",
            "type":"boolean"
        },
        "userSeqResetFreqCd":{
            "description":"The reset frequency for the user sequence.",
            "type":"string"
        },
        "systemSeqName":{
            "description":"The system sequence name",
            "type":"string",
            "maxLength":30
        },
        "DmTmIdentifierParametersDTO":{
            "description":"An array of Identifier Parameters DTO objects.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmTmIdentifierParametersDTO"
            }
        }
    }
}

Nested Schema : DmTmIdentifierParametersDTO

Type: array

An array of Identifier Parameters DTO objects.

Show Source

• Array of: object DmTmIdentifierParametersDTO

{
    "description":"An array of Identifier Parameters DTO objects.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/DmTmIdentifierParametersDTO"
    }
}

Nested Schema : DmTmIdentifierParametersDTO

Type: object

Show Source

• enable(optional): boolean
  Enable flag.
• id(optional): string
  ID
• identifierdefinitionMasterId(optional): string
  Identifier definition master ID.
• sequenceNumber(optional): integer
  Sequence number.
• unitsCd(optional): string
  Units code.
• userSeqResetDt(optional): string
  User sequence reset date.
• userSeqValCur(optional): integer
  User sequence value currency.
• value(optional): string
  Value.

{
    "type":"object",
    "properties":{
        "sequenceNumber":{
            "description":"Sequence number.",
            "type":"integer"
        },
        "unitsCd":{
            "description":"Units code.",
            "type":"string"
        },
        "value":{
            "description":"Value.",
            "type":"string"
        },
        "enable":{
            "description":"Enable flag.",
            "type":"boolean"
        },
        "userSeqValCur":{
            "description":"User sequence value currency.",
            "type":"integer"
        },
        "userSeqResetDt":{
            "description":"User sequence reset date.",
            "type":"string"
        },
        "id":{
            "description":"ID",
            "type":"string"
        },
        "identifierdefinitionMasterId":{
            "description":"Identifier definition master ID.",
            "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