Use a GET request without modifying it to retrieve resource representation or information.
Since GET requests do not change the status of the resource, they are considered to be a safe method. Additionally, GET APIs should be idempotent, meaning that multiple identical requests must produce the same result every time until another POST or PUT API changes the status of the resource on the server.
The new REST API is fully integrated with the open API (Swagger) whereby the structure of the body of the response is known before the API is called.
http://<Domain name>:<PORT>/api/[VERSION_NO]/lu/<LU Name>/<iid>/[[TABLE_NAME]?fields=VALUE1,VALUE2&where=WHERE STATEMENT]] query=QUERY STATMENT]&token=[API Key]&[format=json/xml]&SET={mode,value}
Examples:
http://localhost:3213/api/v1.0/lu/CUSTOMER/1?token=ABC
Bring all data for CUSTOMER LU Instance ID 1
Response Body: response body supports streaming solution
http://localhost:3213/api/v1.0/lu/CUSOMTER/1/ALLERGIES?token=ABC
Bring data for CUSTOMER LU Instance ID 1, table ALLERGIES
http://localhost:3213/api/v1.0/lu/CUSTOMER/1/PAYMENT?fields=PAYMENT_ID,PAYMENT_DATE&where=PAYMENT_STATUS!=’CLOSED’&token=ABC
Bring data for CUSTOMER LU Instance ID 1, table PAYMENT, fields PAYMENT_ID, PAYMENT_DATE where payments are not closed.
http://localhost:3213/api/v1.0/lu/CUSTOMER/1?query=SELECT FIRST_NAME FROM ADDRESS_DATA A, ADDRESS_NAME_LINK B WHERE A.ADDRESS_ID =B.ADDRESS_ID AND B.ADDRESS_TYPE=’P’&token=ABC
Bring data for CUSTOMER LU Instance ID 1, table ADDRESS_DATA field FIRST_NAME where name type is private.
http://localhost:3213/api/v1.0/lu/CUSTOMER/1?query=SELECT FIRST_NAME FROM ADDRESS_DATA A,ADDRESS_NAME_LINK B WHERE A.ADDRESS_ID =B.ADDRESS_ID AND B.ADDRESS_TYPE=’P’&token=ABC&set=sync,force&SET=ENVIRONMENT,ENV1&set=GLOBAL_LION,10
Bring data for CUSTOMER LU Instance ID 1, table ADDRESS_DATA field FIRST_NAME where name type is private. Make sure sync mode is force and run it on ENV1 and set GLOBAL_LION to 10
http://<Domain name>:<PORT>/api/[VERSION_NO]/lu/<LU Name>?token=<API Key>&[format=json/xml/yaml]
Examples:
http://localhost:3213/api/v1.0/lu/CUSTOMER?token=ABC
Bring metadata for CUSTOMER LU
http://[Domain name]:[PORT]/api/[VERSION_NO]/COMMON/[table name]?token=[API Key]&[format=json/xml/yaml]
Example:
http://localhost:3213/api/v1.0/COMMON?token=ABC
Bring metadata for all COMMON tables
http://<Domain name>:<PORT>/api/[VERSION_NO]/common/[COMMON TABLE NAME?fields=list of fields separated by comma&where=WHERE STATEMENT]&token=<API Key>&[format=json/xml]
Examples:
http://localhost:3213/api/v1.0/COMMON/CITIES?token=ABC&schema=demo
Bring all data from CITIES common table related to demo schema
[http://localhost:3213/api/v1.0/COMMON/ADDRESSES?fields=CTIY_NAME&where=CITY=’TEL](http://localhost:3213/api/v1.0/COMMON/ADDRESSES?fields=CTIY_NAME&where=CITY='TEL) AVIV’&token=ABC
Bring city_name from ADDRESSES common table where city is ’TEL AVIV’
http://<Domain Name>:<PORT>/api/[VERSION_NO]/<Graphit file name>/ PARAM1 VALUE1/PARAM2 VALUE2?token=<API Key>&[format=json/xml/yaml]
Example
http://localhost:3213/api/v1.3/graphit/customer_query/1?token=ABC
Run the Web Service according to the customer_query.1.3 Graphit file, send 2 parameters as input (id =1 and name = moshe) and response body should input JSON structure be defined on the Graphit file.
Should call Graphit: customer_query.1.3.graphit file.
http://<Domain name>:<PORT>/api/[VERSION_NO]/{customized Web-Service name}/PARAM1 VALUE1/PARAM2 VALUE2?token=<API Key>&[format=json/xml]
Example:
http://localhost:3213/api/v1.0/Orders/1/Open?token=ABC&format=json
Call Orders Web Service and bring the output structure in JSON format according to input parameters i_order_id = 1 and i_order_status=Open
Indicates whether the Fabric is up and running on the given domain and port.
http://<Domain name>:<PORT>/api/isAlive
Component |
Description |
Mandatory |
Example |
Default |
Domain name |
Domain name |
Y |
localhost |
|
PORT |
PORT |
Y |
3213 |
|
Api |
API |
Y |
api |
Example:
http://localhost:3213/api/isAlive
Parameter |
Mandatory |
Value |
Token |
Y |
API Key |
Accept |
Y |
Json/XML/RAW/CSV |
Any additional parameters |
N |
Parameter=value, can be provided on both the URL and header |
During a failure, the error description structure is returned according to RFC 7807 guidelines with the required details.
Use a GET request without modifying it to retrieve resource representation or information.
Since GET requests do not change the status of the resource, they are considered to be a safe method. Additionally, GET APIs should be idempotent, meaning that multiple identical requests must produce the same result every time until another POST or PUT API changes the status of the resource on the server.
The new REST API is fully integrated with the open API (Swagger) whereby the structure of the body of the response is known before the API is called.
http://<Domain name>:<PORT>/api/[VERSION_NO]/lu/<LU Name>/<iid>/[[TABLE_NAME]?fields=VALUE1,VALUE2&where=WHERE STATEMENT]] query=QUERY STATMENT]&token=[API Key]&[format=json/xml]&SET={mode,value}
Examples:
http://localhost:3213/api/v1.0/lu/CUSTOMER/1?token=ABC
Bring all data for CUSTOMER LU Instance ID 1
Response Body: response body supports streaming solution
http://localhost:3213/api/v1.0/lu/CUSOMTER/1/ALLERGIES?token=ABC
Bring data for CUSTOMER LU Instance ID 1, table ALLERGIES
http://localhost:3213/api/v1.0/lu/CUSTOMER/1/PAYMENT?fields=PAYMENT_ID,PAYMENT_DATE&where=PAYMENT_STATUS!=’CLOSED’&token=ABC
Bring data for CUSTOMER LU Instance ID 1, table PAYMENT, fields PAYMENT_ID, PAYMENT_DATE where payments are not closed.
http://localhost:3213/api/v1.0/lu/CUSTOMER/1?query=SELECT FIRST_NAME FROM ADDRESS_DATA A, ADDRESS_NAME_LINK B WHERE A.ADDRESS_ID =B.ADDRESS_ID AND B.ADDRESS_TYPE=’P’&token=ABC
Bring data for CUSTOMER LU Instance ID 1, table ADDRESS_DATA field FIRST_NAME where name type is private.
http://localhost:3213/api/v1.0/lu/CUSTOMER/1?query=SELECT FIRST_NAME FROM ADDRESS_DATA A,ADDRESS_NAME_LINK B WHERE A.ADDRESS_ID =B.ADDRESS_ID AND B.ADDRESS_TYPE=’P’&token=ABC&set=sync,force&SET=ENVIRONMENT,ENV1&set=GLOBAL_LION,10
Bring data for CUSTOMER LU Instance ID 1, table ADDRESS_DATA field FIRST_NAME where name type is private. Make sure sync mode is force and run it on ENV1 and set GLOBAL_LION to 10
http://<Domain name>:<PORT>/api/[VERSION_NO]/lu/<LU Name>?token=<API Key>&[format=json/xml/yaml]
Examples:
http://localhost:3213/api/v1.0/lu/CUSTOMER?token=ABC
Bring metadata for CUSTOMER LU
http://[Domain name]:[PORT]/api/[VERSION_NO]/COMMON/[table name]?token=[API Key]&[format=json/xml/yaml]
Example:
http://localhost:3213/api/v1.0/COMMON?token=ABC
Bring metadata for all COMMON tables
http://<Domain name>:<PORT>/api/[VERSION_NO]/common/[COMMON TABLE NAME?fields=list of fields separated by comma&where=WHERE STATEMENT]&token=<API Key>&[format=json/xml]
Examples:
http://localhost:3213/api/v1.0/COMMON/CITIES?token=ABC&schema=demo
Bring all data from CITIES common table related to demo schema
[http://localhost:3213/api/v1.0/COMMON/ADDRESSES?fields=CTIY_NAME&where=CITY=’TEL](http://localhost:3213/api/v1.0/COMMON/ADDRESSES?fields=CTIY_NAME&where=CITY='TEL) AVIV’&token=ABC
Bring city_name from ADDRESSES common table where city is ’TEL AVIV’
http://<Domain Name>:<PORT>/api/[VERSION_NO]/<Graphit file name>/ PARAM1 VALUE1/PARAM2 VALUE2?token=<API Key>&[format=json/xml/yaml]
Example
http://localhost:3213/api/v1.3/graphit/customer_query/1?token=ABC
Run the Web Service according to the customer_query.1.3 Graphit file, send 2 parameters as input (id =1 and name = moshe) and response body should input JSON structure be defined on the Graphit file.
Should call Graphit: customer_query.1.3.graphit file.
http://<Domain name>:<PORT>/api/[VERSION_NO]/{customized Web-Service name}/PARAM1 VALUE1/PARAM2 VALUE2?token=<API Key>&[format=json/xml]
Example:
http://localhost:3213/api/v1.0/Orders/1/Open?token=ABC&format=json
Call Orders Web Service and bring the output structure in JSON format according to input parameters i_order_id = 1 and i_order_status=Open
Indicates whether the Fabric is up and running on the given domain and port.
http://<Domain name>:<PORT>/api/isAlive
Component |
Description |
Mandatory |
Example |
Default |
Domain name |
Domain name |
Y |
localhost |
|
PORT |
PORT |
Y |
3213 |
|
Api |
API |
Y |
api |
Example:
http://localhost:3213/api/isAlive
Parameter |
Mandatory |
Value |
Token |
Y |
API Key |
Accept |
Y |
Json/XML/RAW/CSV |
Any additional parameters |
N |
Parameter=value, can be provided on both the URL and header |
During a failure, the error description structure is returned according to RFC 7807 guidelines with the required details.