Jump to

• Request
• Response

Add New Identifier Definition

post

/obedm-common-services/identifierdefinition

This endpoint is used to add a new identifier definition.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

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

Body ()

Request body that contains data required for creating a new identifier definition.

Root 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: string
  The branch code associated with the entity.
• checkSum: boolean
  Whether the entity has a checksum.
• DmTmIdentifierParametersDTO: array DmTmIdentifierParametersDTO
  An array of Identifier Parameters DTO objects.
• entityTypeCd: string
  The entity type code.
• fixedLength: boolean
  Whether the entity has a fixed length.
• maxLength: integer
  The maximum length of the entity.
• productProcessor: string
  The product processor for the entity.
• systemSeqName: string
  Maximum Length: 30

  The system sequence name
• userSeqResetFreqCd: 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: boolean
  Enable flag.
• id: string
  ID
• identifierdefinitionMasterId: string
  Identifier definition master ID.
• sequenceNumber: integer
  Sequence number.
• unitsCd: string
  Units code.
• userSeqResetDt: string
  User sequence reset date.
• userSeqValCur: integer
  User sequence value currency.
• value: 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"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of success or failure.

Headers

• Location: string
  URL of newly created Identifier Definition.

Body ()

Root Schema : ResponseDtoWrapper

Type: object

Show Source

• data: object ResponseResourceSupport
• messages: 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: array codes
  An array of response codes.
• getResponse: object NotesCollection
  Collection of Notes.
• id: string
  The ID of the response.
• requestId: string
  The ID of the request associated with the response.
• saveResponse: object inlineResponse201
  ID of the newly created order.
• status: string
  The status of the response.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the response."
        },
        "status":{
            "type":"string",
            "description":"The status of the response."
        },
        "codes":{
            "type":"array",
            "description":"An array of response codes.",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string",
            "description":"The ID of the request associated with the response."
        },
        "saveResponse":{
            "$ref":"#/definitions/inlineResponse201"
        },
        "getResponse":{
            "$ref":"#/definitions/NotesCollection"
        }
    }
}

Nested Schema : codes

Type: array

An array of response codes.

Show Source

• Array of: object ResponseCode
  Response code for account.

{
    "type":"array",
    "description":"An array of response codes.",
    "items":{
        "$ref":"#/definitions/ResponseCode"
    }
}

Nested Schema : NotesCollection

Type: object

Collection of Notes.

Show Source

• notesList: array notesList

{
    "description":"Collection of Notes.",
    "type":"object",
    "properties":{
        "notesList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/NotesModel"
            }
        }
    }
}

Nested Schema : inlineResponse201

Type: object

ID of the newly created order.

Show Source

• id: string

{
    "description":"ID of the newly created order.",
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : ResponseCode

Type: object

Response code for account.

Show Source

• arg: string
  The argument used in the response message.
• args: array args
  The arguments used in the response message.
• Code: string
  The code representing the response status.
• Desc: string
  The description of the response status.
• Language: string
  The language used for the response message.
• Type: string
  The type of the response status.

{
    "type":"object",
    "description":"Response code for account.",
    "properties":{
        "Code":{
            "type":"string",
            "description":"The code representing the response status."
        },
        "Desc":{
            "type":"string",
            "description":"The description of the response status."
        },
        "Type":{
            "type":"string",
            "description":"The type of the response status."
        },
        "Language":{
            "type":"string",
            "description":"The language used for the response message."
        },
        "args":{
            "type":"array",
            "description":"The arguments used in the response message.",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string",
            "description":"The argument used in the response message."
        }
    }
}

Nested Schema : args

Type: array

The arguments used in the response message.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"The arguments used in the response message.",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Nested Schema : notesList

Type: array

Show Source

• Array of: object NotesModel
  Notes model

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

Nested Schema : NotesModel

Type: object

Notes model

Show Source

• accountId: string
  The unique identifier of the account for which the note is created.
• actionId: string
  Action ID linked to the Note
• alert: string
  Alert Flag
• applyToAllAccounts: boolean
  Apply To All Accounts Flag
• capturedBy: string
  The unique identifier of the user who captured the note.
• caseId: string
  Case Id
• createdDate: string
  Created Date
• desc: string
  A description of the note.
• notesId: string
  The unique identifier of the note.
• notesType: string
  The type of the note.
• status: string
  The status of the note.

{
    "description":"Notes model",
    "type":"object",
    "properties":{
        "notesId":{
            "description":"The unique identifier of the note.",
            "type":"string"
        },
        "accountId":{
            "description":"The unique identifier of the account for which the note is created.",
            "type":"string"
        },
        "alert":{
            "description":"Alert Flag",
            "type":"string"
        },
        "createdDate":{
            "description":"Created Date",
            "type":"string"
        },
        "capturedBy":{
            "description":"The unique identifier of the user who captured the note.",
            "type":"string"
        },
        "status":{
            "description":"The status of the note.",
            "type":"string"
        },
        "notesType":{
            "description":"The type of the note.",
            "type":"string"
        },
        "desc":{
            "description":"A description of the note.",
            "type":"string"
        },
        "actionId":{
            "description":"Action ID linked to the Note",
            "type":"string"
        },
        "applyToAllAccounts":{
            "description":"Apply To All Accounts Flag",
            "type":"boolean"
        },
        "caseId":{
            "description":"Case 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