Get Verb

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.

  • If the Request-URI refers to a data-producing process, the produced data is returned as the entity in the response and not the source text of the process, unless that text is the output of the process.
  • If the resource of a given HTTP GET API is found on the server, it returns the HTTP 200 OK response code together with the response body, which is either XML or JSON content (due to their platform independent nature).
  • If the resource is NOT found on server, it returns the HTTP 404 NOT FOUND response code.
  • If the GET request is incorrectly written, the server returns the HTTP 400 BAD REQUEST response code.

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.

Get LU Data

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}

Component

Description

Mandatory

Example

Default

Domain name

Domain name

Y

localhost

 

PORT

PORT

Y

3213

 

api

API

Y

api

 

VERSION_NO

Version number

N

V1.4

Latest version

lu

Lu

Y

lu

 

LU Name

Logical unit name

Y

CUSTOMER

 

Iid

Instance ID

Y

1

 

TABLE_NAME

Table name

N

PAYMENT

All tables

Fields

Field name

N

fields=CUSTOMER_ID, INVOICE_ID

Multiple fields supported

where

Where statement for the selected table

N

where=NAME=’MOSHE’ OR ADDRESS=’TEL AVIV’

Can be populated if FIELDS are populated

QUERY

Where statement for cross LU tables on the same LU

N

QUERY=SELECT NAME from ADDRESS_DATA A,ADDRESS_NAME_LINK B WHERE A.ADDRESS_ID =B.ADDRESS_ID

 

token

API Key

Y

   

format

Response format

Y

JSON/XML

JSON

Set

Sync mode

N

SET=sync,off SET=sync,on SET=sync,force

Sync policy on the session

 Set

Environment

N

SET=ENVIRONMENT,’ENV1’

_dev

 Set

Sync_timeout

N

SET=SYNC_TIMEOUT,10

Set on config.ini

 Set

instance_ttl

N

SET=instance_ttl,10

 
 Set

Environment variable

N

SET=A,4

 

 

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

Get LU Schema (Metadata)

http://<Domain name>:<PORT>/api/[VERSION_NO]/lu/<LU Name>?token=<API Key>&[format=json/xml/yaml]

Component

Description

Mandatory

Example

Default

Domain name

Domain name

Y

localhost

 

PORT

PORT

Y

3213

 

Api

API

Y

api

 

VERSION_NO

Version number

N

V1.4

Latest version

Lu

lu

Y

lu

 

LU Name

Logical unit name

Y

CUSTOMER

 

Token

API Key

Y

   

Format

Response format

Y

JSON/XML

JSON

 

Examples:

  • http://localhost:3213/api/v1.0/lu/CUSTOMER?token=ABC

    Bring metadata for CUSTOMER LU

Get Common Schema (Metadata)

http://[Domain name]:[PORT]/api/[VERSION_NO]/COMMON/[table name]?token=[API Key]&[format=json/xml/yaml]

Component

Description

Mandatory

Example

Default

Domain name

Domain name

Y

localhost

 

PORT

PORT

Y

3213

 

Api

API

Y

api

 

VERSION_NO

Version number

N

V1.4

Latest version

COMMON

Common tables

Y

COMMON

 

Token

API Key

Y

   

Format

Response format

Y

JSON/XML

JSON

 

Example:

  • http://localhost:3213/api/v1.0/COMMON?token=ABC

    Bring metadata for all COMMON tables

Get Common Table

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]

Component

Description

Mandatory

Example

Default

Domain name

Domain name

Y

localhost

 

PORT

PORT

Y

3213

 

Api

API

Y

api

 

COMMON

Specify that scope is common

Y

COMMON

 

COMMON TABLE NAME

Common table name

N

ADDRESSES

 

where

Where statement for the common table

N

WHERE={CITY=’TEL AVIV’}

Can be populated if the COMMON TABLE NAME is populated

fields

List of fields to be returned as output

N

fields=CITY,ADDRESS

 

Token

API Key

Y

   

Format

Response format

Y

JSON/XML

JSON

schema

Reference table schema name

N

A valid schema name

common if empty

 

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’

Get Based On Graphit File

http://<Domain Name>:<PORT>/api/[VERSION_NO]/<Graphit file name>/ PARAM1 VALUE1/PARAM2 VALUE2?token=<API Key>&[format=json/xml/yaml]

Component

Description

Mandatory

Example

Default

Domain name

Domain name

Y

localhost

 

PORT

PORT

Y

3213

 

Api

API

Y

api

 

VERSION_NO

Version number

N

V1.4

1.0

Token

API Key

Y

   

Format

Response format

Y

JSON/XML

JSON

Graphit file name

Name of graphit file

Y

file name should include the version number customer_query.1.4.graphit

 

PARAM1…N

Input parameter 1..N name and value to the graphit file

N

iid=1&name=moshe

Supported only for Post verb, should be part of the request body {parameter name:parameter value}

 

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.

Get Custom Web Service

http://<Domain name>:<PORT>/api/[VERSION_NO]/{customized Web-Service name}/PARAM1 VALUE1/PARAM2 VALUE2?token=<API Key>&[format=json/xml]

Component

Description

Mandatory

Example

Default

Domain name

Domain name

Y

localhost

 

PORT

PORT

Y

3213

 

Api

API

Y

api

 

VERSION_NO

Version number

N

V1.4

Latest version

Customized Web Service name

Name of the Web Service to be executed

Y

Orders

 

PARAM1…N

Web Service input parameters

N

/1/3 Assuming two parameters as input i_order_id and order_status it will pass 1 to i_order_id and 3 to i_order_status

 

Format

Response format

Y

JSON/XML

JSON

 

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

isAlive

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

Request Header

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

 

Response Body During A Failure

During a failure, the error description structure is returned according to RFC 7807 guidelines with the required details.

Previous

Get Verb

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.

  • If the Request-URI refers to a data-producing process, the produced data is returned as the entity in the response and not the source text of the process, unless that text is the output of the process.
  • If the resource of a given HTTP GET API is found on the server, it returns the HTTP 200 OK response code together with the response body, which is either XML or JSON content (due to their platform independent nature).
  • If the resource is NOT found on server, it returns the HTTP 404 NOT FOUND response code.
  • If the GET request is incorrectly written, the server returns the HTTP 400 BAD REQUEST response code.

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.

Get LU Data

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}

Component

Description

Mandatory

Example

Default

Domain name

Domain name

Y

localhost

 

PORT

PORT

Y

3213

 

api

API

Y

api

 

VERSION_NO

Version number

N

V1.4

Latest version

lu

Lu

Y

lu

 

LU Name

Logical unit name

Y

CUSTOMER

 

Iid

Instance ID

Y

1

 

TABLE_NAME

Table name

N

PAYMENT

All tables

Fields

Field name

N

fields=CUSTOMER_ID, INVOICE_ID

Multiple fields supported

where

Where statement for the selected table

N

where=NAME=’MOSHE’ OR ADDRESS=’TEL AVIV’

Can be populated if FIELDS are populated

QUERY

Where statement for cross LU tables on the same LU

N

QUERY=SELECT NAME from ADDRESS_DATA A,ADDRESS_NAME_LINK B WHERE A.ADDRESS_ID =B.ADDRESS_ID

 

token

API Key

Y

   

format

Response format

Y

JSON/XML

JSON

Set

Sync mode

N

SET=sync,off SET=sync,on SET=sync,force

Sync policy on the session

 Set

Environment

N

SET=ENVIRONMENT,’ENV1’

_dev

 Set

Sync_timeout

N

SET=SYNC_TIMEOUT,10

Set on config.ini

 Set

instance_ttl

N

SET=instance_ttl,10

 
 Set

Environment variable

N

SET=A,4

 

 

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

Get LU Schema (Metadata)

http://<Domain name>:<PORT>/api/[VERSION_NO]/lu/<LU Name>?token=<API Key>&[format=json/xml/yaml]

Component

Description

Mandatory

Example

Default

Domain name

Domain name

Y

localhost

 

PORT

PORT

Y

3213

 

Api

API

Y

api

 

VERSION_NO

Version number

N

V1.4

Latest version

Lu

lu

Y

lu

 

LU Name

Logical unit name

Y

CUSTOMER

 

Token

API Key

Y

   

Format

Response format

Y

JSON/XML

JSON

 

Examples:

  • http://localhost:3213/api/v1.0/lu/CUSTOMER?token=ABC

    Bring metadata for CUSTOMER LU

Get Common Schema (Metadata)

http://[Domain name]:[PORT]/api/[VERSION_NO]/COMMON/[table name]?token=[API Key]&[format=json/xml/yaml]

Component

Description

Mandatory

Example

Default

Domain name

Domain name

Y

localhost

 

PORT

PORT

Y

3213

 

Api

API

Y

api

 

VERSION_NO

Version number

N

V1.4

Latest version

COMMON

Common tables

Y

COMMON

 

Token

API Key

Y

   

Format

Response format

Y

JSON/XML

JSON

 

Example:

  • http://localhost:3213/api/v1.0/COMMON?token=ABC

    Bring metadata for all COMMON tables

Get Common Table

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]

Component

Description

Mandatory

Example

Default

Domain name

Domain name

Y

localhost

 

PORT

PORT

Y

3213

 

Api

API

Y

api

 

COMMON

Specify that scope is common

Y

COMMON

 

COMMON TABLE NAME

Common table name

N

ADDRESSES

 

where

Where statement for the common table

N

WHERE={CITY=’TEL AVIV’}

Can be populated if the COMMON TABLE NAME is populated

fields

List of fields to be returned as output

N

fields=CITY,ADDRESS

 

Token

API Key

Y

   

Format

Response format

Y

JSON/XML

JSON

schema

Reference table schema name

N

A valid schema name

common if empty

 

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’

Get Based On Graphit File

http://<Domain Name>:<PORT>/api/[VERSION_NO]/<Graphit file name>/ PARAM1 VALUE1/PARAM2 VALUE2?token=<API Key>&[format=json/xml/yaml]

Component

Description

Mandatory

Example

Default

Domain name

Domain name

Y

localhost

 

PORT

PORT

Y

3213

 

Api

API

Y

api

 

VERSION_NO

Version number

N

V1.4

1.0

Token

API Key

Y

   

Format

Response format

Y

JSON/XML

JSON

Graphit file name

Name of graphit file

Y

file name should include the version number customer_query.1.4.graphit

 

PARAM1…N

Input parameter 1..N name and value to the graphit file

N

iid=1&name=moshe

Supported only for Post verb, should be part of the request body {parameter name:parameter value}

 

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.

Get Custom Web Service

http://<Domain name>:<PORT>/api/[VERSION_NO]/{customized Web-Service name}/PARAM1 VALUE1/PARAM2 VALUE2?token=<API Key>&[format=json/xml]

Component

Description

Mandatory

Example

Default

Domain name

Domain name

Y

localhost

 

PORT

PORT

Y

3213

 

Api

API

Y

api

 

VERSION_NO

Version number

N

V1.4

Latest version

Customized Web Service name

Name of the Web Service to be executed

Y

Orders

 

PARAM1…N

Web Service input parameters

N

/1/3 Assuming two parameters as input i_order_id and order_status it will pass 1 to i_order_id and 3 to i_order_status

 

Format

Response format

Y

JSON/XML

JSON

 

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

isAlive

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

Request Header

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

 

Response Body During A Failure

During a failure, the error description structure is returned according to RFC 7807 guidelines with the required details.

Previous