Jump to

• Request
• Response

Create, Update, or Delete Identifier Type

post

/api/CXIPlatformService/{version}/CXIReferenceEntity/identifierType

Create, update, or delete one or more Identifier Type records.

Request

Path Parameters

• version(required): string
  API version. Example: v1

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• items(required): array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "required":[
                    "operation",
                    "data"
                ],
                "type":"object",
                "properties":{
                    "data":{
                        "type":"object",
                        "properties":{
                            "code":{
                                "type":"string",
                                "description":"Identifier Type code."
                            },
                            "format":{
                                "type":"string",
                                "description":"Format of the identifier Type."
                            },
                            "active":{
                                "type":"boolean",
                                "description":"Status of identifier Type."
                            },
                            "shortLabel":{
                                "type":"string",
                                "description":"Short Label of the Identifier Type."
                            },
                            "id":{
                                "type":"string",
                                "description":"Id of the Identifier Type record."
                            }
                        },
                        "required":[
                            "id",
                            "active",
                            "code",
                            "format",
                            "shortLabel"
                        ]
                    },
                    "operation":{
                        "type":"string",
                        "description":"The field specifies the mode of operation. Supported operations: create, update or delete."
                    }
                }
            },
            "x-cardinality":"1"
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "required":[
            "operation",
            "data"
        ],
        "type":"object",
        "properties":{
            "data":{
                "type":"object",
                "properties":{
                    "code":{
                        "type":"string",
                        "description":"Identifier Type code."
                    },
                    "format":{
                        "type":"string",
                        "description":"Format of the identifier Type."
                    },
                    "active":{
                        "type":"boolean",
                        "description":"Status of identifier Type."
                    },
                    "shortLabel":{
                        "type":"string",
                        "description":"Short Label of the Identifier Type."
                    },
                    "id":{
                        "type":"string",
                        "description":"Id of the Identifier Type record."
                    }
                },
                "required":[
                    "id",
                    "active",
                    "code",
                    "format",
                    "shortLabel"
                ]
            },
            "operation":{
                "type":"string",
                "description":"The field specifies the mode of operation. Supported operations: create, update or delete."
            }
        }
    },
    "x-cardinality":"1"
}

Nested Schema : items

Type: object

Show Source

• data(required): object data
• operation(required): string
  The field specifies the mode of operation. Supported operations: create, update or delete.

{
    "required":[
        "operation",
        "data"
    ],
    "type":"object",
    "properties":{
        "data":{
            "type":"object",
            "properties":{
                "code":{
                    "type":"string",
                    "description":"Identifier Type code."
                },
                "format":{
                    "type":"string",
                    "description":"Format of the identifier Type."
                },
                "active":{
                    "type":"boolean",
                    "description":"Status of identifier Type."
                },
                "shortLabel":{
                    "type":"string",
                    "description":"Short Label of the Identifier Type."
                },
                "id":{
                    "type":"string",
                    "description":"Id of the Identifier Type record."
                }
            },
            "required":[
                "id",
                "active",
                "code",
                "format",
                "shortLabel"
            ]
        },
        "operation":{
            "type":"string",
            "description":"The field specifies the mode of operation. Supported operations: create, update or delete."
        }
    }
}

Nested Schema : data

Type: object

Show Source

• active(required): boolean
  Status of identifier Type.
• code(required): string
  Identifier Type code.
• format(required): string
  Format of the identifier Type.
• id(required): string
  Id of the Identifier Type record.
• shortLabel(required): string
  Short Label of the Identifier Type.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Identifier Type code."
        },
        "format":{
            "type":"string",
            "description":"Format of the identifier Type."
        },
        "active":{
            "type":"boolean",
            "description":"Status of identifier Type."
        },
        "shortLabel":{
            "type":"string",
            "description":"Short Label of the Identifier Type."
        },
        "id":{
            "type":"string",
            "description":"Id of the Identifier Type record."
        }
    },
    "required":[
        "id",
        "active",
        "code",
        "format",
        "shortLabel"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: object

Show Source

• active(required): boolean
  Status of identifier Type.
• code(required): string
  Identifier Type code.
• format(required): string
  Format of the identifier Type.
• id(required): string
  Id of the Identifier Type record.
• shortLabel(required): string
  Short Label of the Identifier Type.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Identifier Type code."
        },
        "format":{
            "type":"string",
            "description":"Format of the identifier Type."
        },
        "active":{
            "type":"boolean",
            "description":"Status of identifier Type."
        },
        "shortLabel":{
            "type":"string",
            "description":"Short Label of the Identifier Type."
        },
        "id":{
            "type":"string",
            "description":"Id of the Identifier Type record."
        }
    },
    "required":[
        "id",
        "active",
        "code",
        "format",
        "shortLabel"
    ]
}

400 Response

An error is encountered due to an invalid request

Body ()

Root Schema : schema

Type: object

Show Source

• code: string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error code extension

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common\nlist."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which\ncan be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        }
    }
}

500 Response

An internal server error is encountered, due to an unknown reason

Body ()

Root Schema : schema

Type: object

Show Source

• code: string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error code extension

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common\nlist."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which\ncan be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        }
    }
}

Back to Top