Jump to

• Request
• Response

Add New Lookup Type

post

/obedm-common-services/lookuptype

This endpoint is used to add a new Lookup Type.

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 Lookup Type.

Root Schema : DmTmLookupTypeDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object DmTmLookupTypeDTO-allOf[1]

{
    "type":"object",
    "required":[
        "lookupTypeCd",
        "lookupTypeDesc",
        "sysDefFlg"
    ],
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "DmTmLookupCodeDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/DmTmLookupCodeDTO"
                    }
                }
            }
        }
    ]
}

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

Type: object

Show Source

• DmTmLookupCodeDTO: array DmTmLookupCodeDTO

{
    "type":"object",
    "properties":{
        "DmTmLookupCodeDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmTmLookupCodeDTO"
            }
        }
    }
}

Nested Schema : DmTmLookupCodeDTO

Type: array

Show Source

• Array of: object DmTmLookupCodeDTO

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

Nested Schema : DmTmLookupCodeDTO

Type: object

Show Source

• enabledFlg: boolean
  Enabled Flag
• id: string
  ID
• lookupCd: string
  Lookup Code
• lookupDesc: string
  Lookup Description
• lookupTypeMasterId: string
  Lookup Type Master ID
• seqNo: integer
  Minimum Value: 0

  Maximum Value: 999

  Sequence Number
• subCodeOne: string
  Sub Code One
• subCodeTwo: string
  Sub Code Two
• sysDefFlg: boolean
  System Def Flag

{
    "type":"object",
    "properties":{
        "lookupCd":{
            "description":"Lookup Code",
            "type":"string"
        },
        "lookupDesc":{
            "description":"Lookup Description",
            "type":"string"
        },
        "seqNo":{
            "description":"Sequence Number",
            "type":"integer",
            "minimum":"0",
            "maximum":"999"
        },
        "sysDefFlg":{
            "description":"System Def Flag",
            "type":"boolean"
        },
        "subCodeOne":{
            "description":"Sub Code One",
            "type":"string"
        },
        "subCodeTwo":{
            "description":"Sub Code Two",
            "type":"string"
        },
        "enabledFlg":{
            "description":"Enabled Flag",
            "type":"boolean"
        },
        "id":{
            "type":"string",
            "description":"ID"
        },
        "lookupTypeMasterId":{
            "type":"string",
            "description":"Lookup Type Master ID"
        }
    }
}

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 Lookup Type.

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
• id: string
• requestId: string
• status: 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: string
• args: array args
• Code: string
• Desc: string
• Language: string
• Type: 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