Delete

Deletes specific records from an entity based on their IDs.

Syntax

Copy 
POST <<i>host_address</i>>/api/openApi/Delete

Content-Type: application/json
            
{ 
    "ApiInfo": {
        "token":<<i>access_token</i>>
    },
    "Request": { 
        "entityName":<<i>entity_name</i>>, 
        "idList":<<i>item_IDs</i>> 
    }
}
 
Parameter Description
host_address URL of the FintechOS platform server.
access_token Access token used to connect to the API endpoint. For details, see GetToken.
entity_name The parent entity, such as entity, attribute, relationship, systemuser, systemusertype, customizationset, businessunit, or portal.
item_IDs List of unique internal identifiers of the records you wish to delete.

Response

Copy 
{
    "Id": null,
    "Message": null,
    "IsSuccess": true,
    "ClientScript": null,
    "ErrorCode": 0,
    "Serialized": null,
    "UIResult": null
}
 
Key Description
IsSuccess Indicates if the records were deleted successfully.

Examples

In this example:

  • We delete customizationsets with the following IDs: 3af016e1-1bcc-408e-8434-364e76bdc9af and 2bc228ae-a688-4051-865f-78fd28c084b5.
  • The server's address is https://FintechOSStudio.
  • The access token used to connect to the API endpoint is e9735b2a-b5f8-461a-9fec-a819a071a2ff. For information on how to obtain the access token, see GetToken.
  • The response indicates that the request was executed successfully ("IsSuccess": true).

Request

Copy 
POST https://FintechOSStudio/api/openApi/GetById

Content-Type: application/json
            
{ 
    "ApiInfo": {
        "token": "e9735b2a-b5f8-461a-9fec-a819a071a2ff"
    },
    "Request": { 
        "entityName": "customizationset", 
        "idList": [
            "3af016e1-1bcc-408e-8434-364e76bdc9af",
            "2bc228ae-a688-4051-865f-78fd28c084b5"
        ] 
    }
}

Response

Copy 
{
    "Id": null,
    "Message": null,
    "IsSuccess": true,
    "ClientScript": null,
    "ErrorCode": 0,
    "Serialized": null,
    "UIResult": null
}