Application. Fetch data by request POST

get data of application by parametrs

# ENDPOINT
/api/application/getData/applicationSearchRequest
# REQUEST arguments
Variable Value Example Usage Description
X-App-Sig
header
0
M Dev Authentication
# REQUEST BODY
# RESPONSE
        						
# REQUEST arguments
Variable Name Type Format Usage Description
X-App-Sig X-App-Sig header string M Dev Authentication
# REQUEST BODY
Schema: applicationSearchRequest
Type: object
Variable Name Type Format Usage Description
application_name application_name string
application_name_like Application name like string
application_scenario Application scenario string
application_section application_section string
application_type application_type string application type
client_code client_code string Unique customer ID in external system
date_from date_from string DATE The period of dates for which you need to receive an extract - date From
date_to date_to string DATE The period of dates for which you need to receive an extract - date To
id id integer INT64 Record's sequence number generated in the system.
limit limit integer int64 Count records for part data to get
link_id Link id integer
offset_version Offset version INTEGER
offsetid Offsetid integer
page page integer int64 Part data with number of page
page_changes_version_offset Page changes version offset INTEGER
processing_status Processing Status string Processing operation status
processing_step Processing step string
quantity_limit_in_package Quantity limit in package integer
skip_total_records Skip total records boolean
List of allowed values in field (value=>name):
  • 0
    false
  • 1
    true
source_id Source id integer
# REQUEST BODY EXAMPLE
							{
    "getData":false,
    "source_system":"IB",
    "client_code":"EN00000CY"
    "page":1,
    "limit":100
}						
# POSITIVE RESPONSE

200 - Response successfully when status is OK

200 - Response successfully when status is OK

Schema: application
Type: application/json
Variable Name Type Format Description
status status string Request execution status
error_description Error Description string Description of error
error Error Code string Error code
data_type data_type string Type of data
total_records total_records string Total count of records
data data array data of Response
attribute: data
Variable Name Type Format Description
action Action string
application_name application_name string
application_scenario Application scenario string
application_section application_section string
application_type application_type string application type
attachments attachments string Attachments
client_code client_code string Unique customer ID in external system
create_date Create Date string DATETIME The date entry was created on
create_user Create User string The username of ABS user who has created an entry
error_description Error Description string Description of error
form_title form_title string Service field
id id integer INT64 Record's sequence number generated in the system.
link_id Link id integer
modify_date Modify Date string DATETIME The date entry was last modified on
modify_user Modify User string The username of ABS user who has made last changes to the entry
oauth_access_token Oauth access token string
overall_status Overall status string
package_id Package id integer
processing_status Processing Status string Processing operation status
processing_step Processing step string
source_id Source id integer
state state integer INT64 Record state for replication
uid uid string Unique record identifier which is used to distinguish between existing records
version version integer INT64 Record version for replication
# RESPONSE POSITIVE EXAMPLE
							{
    "status": "ok",
    "error_description": "",
    "error": {},
    "data_type": "",
    "total_records": 428,
    "data": [
        {
            "id": 559,
            "uid": "a49b4646-68f2-c1bf-8314-38d900629a5f",
            "version": 884583418,
            "state": 0,
            "modify_date": "2021-07-19T19:29:32.781",
            "modify_user": "root",
            "create_date": "2021-07-19T19:29:31.232",
            "create_user": "root",
            "client_code": "EN00000CY",
            "application_type": "applicationContactBookEdit",
            "oauth_access_token": "",
            "processing_status": "MANUAL",
            "processing_step": "NORMAL",
            "error_description": "",
            "application_section": "application",
            "link_id": 0,
            "package_id": 0,
            "source_id": 0,
            "application_name": ""
        },
        {
            "id": 558,
            "uid": "a7b36a77-7b7f-c3a9-8314-35d4d833d92e",
            "version": 884207312,
            "state": 0,
            "modify_date": "2021-07-19T11:50:19.778",
            "modify_user": "root",
            "create_date": "2021-07-19T11:50:14.932",
            "create_user": "root",
            "client_code": "EN00000CY",
            "application_type": "applicationAccountClose",
            "oauth_access_token": "",
            "processing_status": "MANUAL",
            "processing_step": "NORMAL",
            "error_description": "",
            "application_section": "application",
            "link_id": 0,
            "package_id": 0,
            "source_id": 0,
            "application_name": ""
        },
		{
            "id": 556,
            "uid": "e472c8e4-46b1-9f91-8314-fb3728322692",
            "version": 873537313,
            "state": 0,
            "modify_date": "2021-07-09T13:16:01.038",
            "modify_user": "root",
            "create_date": "2021-07-09T13:15:58.647",
            "create_user": "root",
            "client_code": "EN00000CY",
            "application_type": "applicationRepresentativeRoleGrant",
            "oauth_access_token": "",
            "processing_status": "COMPLETED",
            "processing_step": "NORMAL",
            "error_description": "",
            "application_section": "application",
            "link_id": 0,
            "package_id": 0,
            "source_id": 0,
            "application_name": ""
        },
		{
            "id": 535,
            "uid": "94f6d2bc-cf17-1dac-8214-4e8d08a57246",
            "version": 873665552,
            "state": 0,
            "modify_date": "2021-07-09T16:37:36.315",
            "modify_user": "root",
            "create_date": "2021-06-28T16:37:32.266",
            "create_user": "root",
            "client_code": "EN00000CY",
            "application_type": "applicationRepresentativeCreate",
            "oauth_access_token": "",
            "processing_status": "REJECTED",
            "processing_step": "NORMAL",
            "error_description": "",
            "application_section": "application",
            "link_id": 0,
            "package_id": 0,
            "source_id": 0,
            "application_name": ""
        }
	]
}						
# NEGATIVE RESPONSE

200 - Response with error when status is ERROR

200 - Response with error when status is ERROR

Schema: HeaderResponseStatusError
Type: application/json
Variable Name Type Format Description
status status string Request execution status
error_description Error Description string Description of error
error Error Code string Error code
data_type data_type string Type of data
total_records total_records string Total count of records
data data object Empty object