Query

Returns detailed information about all records that meet the specified selection criteria.

Syntax

Copy

POST {<i>host_address</i>}/api/openApi/Query

Content-Type: application/json

{ 
    "ApiInfo":{ 
        "Token": <<i>access_token</i>> 
    }, 
    "Request":{ 
        "entity": {
            "name": <<i>entity_name</i>>,
            "alias": <<i>entity_alias</i>>
        },
        ["where": <<i>filtering_criteria</i>>,] 
        ["page": <<i>paging_criteria</i>>,] 
        ["orderby": <<i>ordering_criteria</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.
`entity_alias`	Assigns a unique alias for the entity. This alias is used to precede the entity's attributes' names when referring to them.
`filtering_criteria`	Criteria for filtering the result set.
`paging_criteria`	Criteria for selecting a specific subset of the result set.
`oredring_criteria`	Criteria for ordering the result set.

Response

Copy

{
    "NumberOfResults": 0,
    "TotalNumber": 0,
    "RequestedSkip": 0,
    "RequestedTake": 0,
    "Records": [
            ...
    ],
    "Message": null,
    "IsSuccess": true,
    "ClientScript": null,
    "Serialized": null,
    "ErrorCode": 0,
    "UIResult": null
}

Key	Description
`Records`	Detailed information about each record in the result set.

Examples

Display all administrator accounts ordered by name

In this example:

We request information about systemusers that are administrators (the isAdministrator field is set to True).
The result set should be ordered by userName.
The server's address is https://FintechOSStudio.
The access token used to connect to the API endpoint is 4d6d0943-328a-4b3b-95ce-3af92e7fd889. For information on how to obtain the access token, see GetToken.
The response returns two user accounts (elena and jdoe), along with all the details for each record.

Request

Copy

POST https://FintechOSStudio/api/openApi/Query

Content-Type: application/json

{
    "apiInfo": {
        "Token": "4d6d0943-328a-4b3b-95ce-3af92e7fd889"
    },
    "request": {
        "entity": {
            "name": "systemuser",
            "alias": "t"
        },
        "where": {
            "type": "and",
            "conditionlist": [
                {
                    "first": "t.isAdministrator",
                    "type": "equals",
                    "second": "val(true)"
                }
            ]
        },
        "page": null,
        "orderby": {
            "type": "asc",
            "attribute": "t.userName"
        }
    }
}

Response

Copy

{
    "NumberOfResults": 2,
    "TotalNumber": 0,
    "RequestedSkip": 0,
    "RequestedTake": 0,
    "Records": [
        {
            "primaryattributedisplayname": "elena",
            "t_picture": "[]",
            "t_systemUserTypeId": "f0481274-2b9f-4b14-b83b-c6cca4cb7c92",
            "t_isGuest": null,
            "t_externalId": 0,
            "t_systemuserid": "2b5da6c2-dcaf-4c38-8015-61ac170c8e5a",
            "t_userName": "elena",
            "t_confirmPassword": null,
            "t_phoneNumber": null,
            "t_isAuthorized": true,
            "t_isAdministrator": true,
            "t_portalId": null,
            "t_externalSystemUserId": null,
            "t_businessUnitId": "a3d2909b-df67-49d6-b7e0-2dc912c12484",
            "t_email": "elena.teodor@fintechos.com",
            "t_password": null,
            "t_displayName": "Elena",
            "aLookup1_name": "Back Office",
            "t_systemUserTypeId_displayname": "Back Office",
            "aLookup2_name": null,
            "t_portalId_displayname": null,
            "aLookup3_name": null,
            "t_externalSystemUserId_displayname": null,
            "aLookup4_name": "root",
            "t_businessUnitId_displayname": "root"
        },
        {
            "primaryattributedisplayname": "jdoe",
            "t_picture": "[{\"Name\":\"Screenshot_2019-08-27 FintechOS.png\",\"RealName\":\"Screenshot_2019-08-27 FintechOS_17ca7108-5997-403f-8d0e-d677e80916dc.png\",\"IsSuccess\":true,\"Message\":null,\"ClientScript\":null,\"Serialized\":null,\"ErrorCode\":0,\"UIResult\":null}]",
            "t_systemUserTypeId": "f0481274-2b9f-4b14-b83b-c6cca4cb7c92",
            "t_isGuest": null,
            "t_externalId": 1,
            "t_systemuserid": "4afdc8a9-eb91-4359-81d6-c3a462fae866",
            "t_userName": "jdoe",
            "t_confirmPassword": null,
            "t_phoneNumber": null,
            "t_isAuthorized": true,
            "t_isAdministrator": true,
            "t_portalId": null,
            "t_externalSystemUserId": null,
            "t_businessUnitId": "a3d2909b-df67-49d6-b7e0-2dc912c12484",
            "t_email": null,
            "t_password": null,
            "t_displayName": "jdoe",
            "aLookup1_name": "Back Office",
            "t_systemUserTypeId_displayname": "Back Office",
            "aLookup2_name": null,
            "t_portalId_displayname": null,
            "aLookup3_name": null,
            "t_externalSystemUserId_displayname": null,
            "aLookup4_name": "root",
            "t_businessUnitId_displayname": "root"
        }
    ],
    "Message": null,
    "IsSuccess": true,
    "ClientScript": null,
    "Serialized": null,
    "ErrorCode": 0,
    "UIResult": null
}

Display detailed information about a sample of 5 relationships

In this example:

We request information about a sample of 5 relationships.
We will pick results 11 through 15 from the result set (skip the first 10 results and take the next 5 results).
The server's address is https://FintechOSStudio.
The access token used to connect to the API endpoint is 4d6d0943-328a-4b3b-95ce-3af92e7fd889. For information on how to obtain the access token, see GetToken.
The response returns the requested relationships row_ids 11 through 15, along with all the details for each record.

Request

Copy

POST https://FintechOSStudio/api/openApi/Query

Content-Type: application/json

{
    "apiInfo": {
        "Token": "4d6d0943-328a-4b3b-95ce-3af92e7fd889"
    },
    "request": {
        "entity": {
            "name": "relationship",
            "alias": "t"
        },
        "where": null,
        "page": {
            "skip": 10,
            "take": 5,
            "returncount": true
        },
        "orderby": null
    }
}

Response

Copy

{
    "NumberOfResults": 5,
    "TotalNumber": 61,
    "RequestedSkip": 10,
    "RequestedTake": 5,
    "Records": [
        {
            "t_relationshipid": "3952fc60-0d0d-405d-bf53-04d5e20cca8e",
            "t_referencingEntityId": "7b670019-7067-42c2-851f-67d46c961b5e",
            "t_referencedEntityId": "2c174e72-56ec-41b6-aaa7-3926ab7de5da",
            "t_name": "ebs_FTOS_DPA_CommunicationChannel_businessunit",
            "t_relationshipConstraint": 1,
            "t_relationshipType": 1,
            "t_displayName": "ebs_FTOS_DPA_CommunicationChannel_businessunit",
            "aLookup1_name": "businessunit",
            "t_referencingEntityId_displayname": "businessunit",
            "aLookup2_name": "FTOS_DPA_CommunicationChannel",
            "t_referencedEntityId_displayname": "FTOS_DPA_CommunicationChannel",
            "row_id": "11"
        },
        {
            "t_relationshipid": "fec4f5ec-798d-41e0-98aa-067a8064c0ab",
            "t_referencingEntityId": "5fd5e75e-0f74-41d8-8f43-660124fc71cd",
            "t_referencedEntityId": "b51b832d-fac7-4668-b657-295ff183d724",
            "t_name": "FTOS_DPA_ChannelProviderStatus_FTOS_DPA_ChannelProvider",
            "t_relationshipConstraint": 0,
            "t_relationshipType": 1,
            "t_displayName": "FTOS_DPA_ChannelProviderStatus_FTOS_DPA_ChannelProvider",
            "aLookup1_name": "FTOS_DPA_ChannelProvider",
            "t_referencingEntityId_displayname": "FTOS_DPA_ChannelProvider",
            "aLookup2_name": "FTOS_DPA_ChannelProviderStatus",
            "t_referencedEntityId_displayname": "FTOS_DPA_ChannelProviderStatus",
            "row_id": "12"
        },
        {
            "t_relationshipid": "bb89d268-3e4e-4aa9-895f-068fa6199f16",
            "t_referencingEntityId": "8be6d4a7-6be4-4bbf-b8d3-f947cc252b13",
            "t_referencedEntityId": "f4bcb339-78d6-42be-8f0e-d778a9b590d4",
            "t_name": "FinChart_workflow",
            "t_relationshipConstraint": 0,
            "t_relationshipType": 1,
            "t_displayName": "FinChart_workflow",
            "aLookup1_name": "workflow",
            "t_referencingEntityId_displayname": "workflow",
            "aLookup2_name": "FinChart",
            "t_referencedEntityId_displayname": "FinChart",
            "row_id": "13"
        },
        {
            "t_relationshipid": "e4a08255-2bcc-4232-b815-075d1151e917",
            "t_referencingEntityId": "18760d51-e9f3-4279-bd7c-a99fc57a2bc8",
            "t_referencedEntityId": "b81a816d-34c1-4429-84ce-6f460514c673",
            "t_name": "MKT_MarketingListMemberToken_MKT_MarketingListMember",
            "t_relationshipConstraint": 2,
            "t_relationshipType": 1,
            "t_displayName": "MKT_MarketingListMemberToken_MKT_MarketingListMember",
            "aLookup1_name": "MKT_MarketingListMember",
            "t_referencingEntityId_displayname": "MKT_MarketingListMember",
            "aLookup2_name": "MKT_MarketingListMemberToken",
            "t_referencedEntityId_displayname": "MKT_MarketingListMemberToken",
            "row_id": "14"
        },
        {
            "t_relationshipid": "f74160de-8166-4e88-b806-07d98c149162",
            "t_referencingEntityId": "4d5d5c0a-e62d-4816-9125-b89c7254839d",
            "t_referencedEntityId": "8be6d4a7-6be4-4bbf-b8d3-f947cc252b13",
            "t_name": "WorkflowWorkflowLibrary",
            "t_relationshipConstraint": 0,
            "t_relationshipType": 2,
            "t_displayName": "WorkflowWorkflowLibrary",
            "aLookup1_name": "workflowLibrary",
            "t_referencingEntityId_displayname": "workflowLibrary",
            "aLookup2_name": "workflow",
            "t_referencedEntityId_displayname": "workflow",
            "row_id": "15"
        }
    ],
    "Message": null,
    "IsSuccess": true,
    "ClientScript": null,
    "Serialized": null,
    "ErrorCode": 0,
    "UIResult": null
}