GetByID

Returns detailed information about a specific record based on its ID and parent entity.

Syntax

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

Content-Type: application/json
            
{ 
    "ApiInfo": {
        "Token":<<i>access_token</i>>
    },
    "Request": { 
        "EntityName":<<i>entity_name</i>>, 
        "EntityId":<<i>item_ID</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_id Unique internal identifier or the record.

Response

Copy 
{
    "NumberOfResults": 0,
    "TotalNumber": 0,
    "RequestedSkip": 0,
    "RequestedTake": 0,
    "Records": [
        {
            "name": "Front Office",
            "displayName": null,
            "systemusertypeid": "adcca965-eb7c-4fbd-a946-90a11dcb46f1",
            "primaryattributedisplayname": "Front Office"
        }
    ],
    "Message": null,
    "IsSuccess": true,
    "ClientScript": null,
    "Serialized": null,
    "ErrorCode": 0,
    "UIResult": null
}
 
Key Description
Records Displays the record's attribute values.

Examples

In this example:

  • We request information about a relationship with the 116839c6-a372-40e5-baef-00d7a4714349 ID.
  • 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, among others, that this is a type 1 relationship called ebs_MKT_ChannelProvider_createdsystemuser between entities systemuser and MKT_ChannelProvider, along with all the corresponding IDs and display names.

Request

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

Content-Type: application/json
            
{ 
    "ApiInfo": {
        "Token": "e9735b2a-b5f8-461a-9fec-a819a071a2ff"
    },
    "Request": { 
        "EntityName": "relationship", 
        "EntityId": "116839c6-a372-40e5-baef-00d7a4714349" 
    }
}

Response

Copy 
{
    "NumberOfResults": 0,
    "TotalNumber": 0,
    "RequestedSkip": 0,
    "RequestedTake": 0,
    "Records": [
        {
            "relationshipid": "116839c6-a372-40e5-baef-00d7a4714349",
            "referencingEntityId": "ac0e8dba-a430-4ead-a8b9-04cbef2149a7",
            "referencedEntityId": "8581fbb4-df4a-466b-b98c-a7abd66b246c",
            "name": "ebs_MKT_ChannelProvider_createdsystemuser",
            "relationshipConstraint": 1,
            "relationshipType": 1,
            "displayName": "ebs_MKT_ChannelProvider_createdsystemuser",
            "primaryattributedisplayname": "ebs_MKT_ChannelProvider_createdsystemuser",
            "aLookup1_name": "systemuser",
            "referencingEntityId_displayname": "systemuser",
            "aLookup2_name": "MKT_ChannelProvider",
            "referencedEntityId_displayname": "MKT_ChannelProvider"
        }
    ],
    "Message": null,
    "IsSuccess": true,
    "ClientScript": null,
    "Serialized": null,
    "ErrorCode": 0,
    "UIResult": null
}

In this example:

  • We request information about a systemuser with the 061ddd8a-3d8d-4288-8d37-f6d98c689b76 ID.
  • 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 user account has been disabled (the isAuthorized key is set to false).

Request

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

Content-Type: application/json
            
{ 
    "ApiInfo": {
        "Token": "e9735b2a-b5f8-461a-9fec-a819a071a2ff"
    },
    "Request": { 
        "EntityName": "systemuser", 
        "EntityId": "061ddd8a-3d8d-4288-8d37-f6d98c689b76" 
    }
}

Response

Copy 
{
    "NumberOfResults": 0,
    "TotalNumber": 0,
    "RequestedSkip": 0,
    "RequestedTake": 0,
    "Records": [
        {
            "picture": "[{\"Name\":\"Drawing1.png\",\"RealName\":\"Drawing1_2443d9b9-b62e-4ce1-9052-6dfeadb9ecbb.png\",\"IsSuccess\":true,\"Message\":null,\"ClientScript\":null,\"Serialized\":null,\"ErrorCode\":0,\"UIResult\":null}]",
            "systemUserTypeId": "f0481274-2b9f-4b14-b83b-c6cca4cb7c92",
            "isGuest": false,
            "externalId": null,
            "systemuserid": "061ddd8a-3d8d-4288-8d37-f6d98c689b76",
            "userName": "jdoe",
            "confirmPassword": null,
            "phoneNumber": "0040729666666",
            "isAuthorized": false,
            "isAdministrator": false,
            "portalId": null,
            "externalSystemUserId": null,
            "businessUnitId": "b107a646-b8d5-4e91-88cc-547c82ac7faa",
            "email": "jdoe@fintechos.com",
            "password": null,
            "displayName": "John",
            "primaryattributedisplayname": "jdoe",
            "aLookup1_name": "Back Office",
            "systemUserTypeId_displayname": "Back Office",
            "aLookup2_name": null,
            "portalId_displayname": null,
            "aLookup3_name": null,
            "externalSystemUserId_displayname": null,
            "aLookup4_name": "Joe Schmoes",
            "businessUnitId_displayname": "Joe Schmoes"
        }
    ],
    "Message": null,
    "IsSuccess": true,
    "ClientScript": null,
    "Serialized": null,
    "ErrorCode": 0,
    "UIResult": null
}