Knowledge Base Academy Community My Tickets

Home Knowledge Base Academy Community My Tickets

Fabric 7.2

Knowledge Base Built-In Common-DB APIs

Built-In Common DB Tables APIs

Fabric provides out-of-the-box web services for querying project's Common data and metadata resources.

An appropriate HTTP status code is used to indicate the status of the executed operation, following standardized status codes that are defined by [RFC7231] and listed in the IANA Status Code Registry.

Any web service call passes authentication and authorization validations before being executed. For more information - see here.

All API accesses are over HTTPS, and are accessed from the Fabric URL endpoint https://<Domain Name>:<PORT>

Get Common DB Schema (Metadata)

Retrieves the Common DB schema, describing the structures of its tables.

GET /api/common[?format=json|xml]

Component	Description	Mandatory	Example	Default
Format	Response format	N	JSON/XML	JSON

Example:

http://localhost:3213/api/common

Brings metadata for all COMMON tables

Get Common Table Data

GET /api/common/<Common Table Name>[?fields=<list of fields separated by comma>[&where=<WHERE STATEMENT>][&format=json|xml]

Component	Description	Mandatory	Example	Default
Common Table Name	Common table name	Y	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
Format	Response format	N	JSON or XML	JSON
schema	Reference table schema name	N	A valid schema name	Common if empty

Examples:

https://localhost:3213/api/common/CITIES?schema=demo

Brings all data from CITIES common table related to the demo schema
https://localhost:3213/api/common/ADDRESSES?fields=CTIY_NAME&where=CITY=’London'

Brings city_name from ADDRESSES common table where city is ’London’

Create Common Table Data

POST /api/common/<Common Table Name>[?format=json|xml]

Component	Description	Mandatory	Example	Default
Common Table Name	Common Table Name	Y	ADDRESSES
schema	Reference table schema name	N	A valid schema name	Common if empty

Example:

https://localhost:3213/api/common/REF_NAMES

Inserts data into common table REF_NAMES

Request Body

{
  "rows": [
    {
      "FIRST_NAME": "XXX",
      "LAST_NAME": "YYY"
    }
  ]
}

Update Common Table Data

PUT /api/common/<Common Table Name>[?format=json|xml]

Component	Description	Mandatory	Example	Default
Common Table Name	Common table name	Y	ADDRESSES
format	Response format	Y	JSON/XML	JSON
schema	Reference table schema name	N	A valid schema name	Common if empty

The request body shall contain the row data to be updated along with an optional 'where' element, as the where condition statement.

Example:

https://localhost:3213/api/common/ADDRESSES

Updates data in common ADDRESSES table

Request Body

 {
    "row" : {"ADDRESS_NAME":"London"} ,
    "where":"ADDRESS_ID=3"
}

Delete Data From a Common Table

DELETE/api/common/<COMMON TABLE NAME>?where=<WHERE CLAUSE>[&format=json|xml]

Component	Description	Mandatory	Example	Default
COMMON TABLE NAME	Common table name	Y	CITIES
WHERE CLAUSE	Where clause statement	Y	CITY_ID=1
format	Response format	N	JSON/XML	JSON
schema	Reference table schema name	N	A valid schema name

Example:

https://localhost:3213/api/common/CITIES&where=CITY_ID=1

Deletes data from CITIES common table where city_id = 1

Built-In Common DB Tables APIs

Fabric provides out-of-the-box web services for querying project's Common data and metadata resources.

Any web service call passes authentication and authorization validations before being executed. For more information - see here.

All API accesses are over HTTPS, and are accessed from the Fabric URL endpoint https://<Domain Name>:<PORT>

Get Common DB Schema (Metadata)

Retrieves the Common DB schema, describing the structures of its tables.

GET /api/common[?format=json|xml]

Component	Description	Mandatory	Example	Default
Format	Response format	N	JSON/XML	JSON

Example:

http://localhost:3213/api/common

Brings metadata for all COMMON tables

Get Common Table Data

GET /api/common/<Common Table Name>[?fields=<list of fields separated by comma>[&where=<WHERE STATEMENT>][&format=json|xml]

Component	Description	Mandatory	Example	Default
Common Table Name	Common table name	Y	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
Format	Response format	N	JSON or XML	JSON
schema	Reference table schema name	N	A valid schema name	Common if empty

Examples:

https://localhost:3213/api/common/CITIES?schema=demo

Brings all data from CITIES common table related to the demo schema
https://localhost:3213/api/common/ADDRESSES?fields=CTIY_NAME&where=CITY=’London'

Brings city_name from ADDRESSES common table where city is ’London’

Create Common Table Data

POST /api/common/<Common Table Name>[?format=json|xml]

Component	Description	Mandatory	Example	Default
Common Table Name	Common Table Name	Y	ADDRESSES
schema	Reference table schema name	N	A valid schema name	Common if empty

Example:

https://localhost:3213/api/common/REF_NAMES

Inserts data into common table REF_NAMES

Request Body

{
  "rows": [
    {
      "FIRST_NAME": "XXX",
      "LAST_NAME": "YYY"
    }
  ]
}

Update Common Table Data

PUT /api/common/<Common Table Name>[?format=json|xml]

Component	Description	Mandatory	Example	Default
Common Table Name	Common table name	Y	ADDRESSES
format	Response format	Y	JSON/XML	JSON
schema	Reference table schema name	N	A valid schema name	Common if empty

The request body shall contain the row data to be updated along with an optional 'where' element, as the where condition statement.

Example:

https://localhost:3213/api/common/ADDRESSES

Updates data in common ADDRESSES table

Request Body

 {
    "row" : {"ADDRESS_NAME":"London"} ,
    "where":"ADDRESS_ID=3"
}

Delete Data From a Common Table

DELETE/api/common/<COMMON TABLE NAME>?where=<WHERE CLAUSE>[&format=json|xml]

Component	Description	Mandatory	Example	Default
COMMON TABLE NAME	Common table name	Y	CITIES
WHERE CLAUSE	Where clause statement	Y	CITY_ID=1
format	Response format	N	JSON/XML	JSON
schema	Reference table schema name	N	A valid schema name

Example:

https://localhost:3213/api/common/CITIES&where=CITY_ID=1

Deletes data from CITIES common table where city_id = 1