Post Verb

Use POST APIs to create new subordinate resources. For example, a file that is subordinate to the directory containing it, or a row that is subordinate to a database table.

Strictly in terms of REST, POST methods can be used to create a new resource in a collection of resources.

Ideally, if a resource has been created on the origin server, the response code SHOULD be HTTP 201 Created and contain:

  • An entity describing the request's status.
  • A reference to the new resource.
  • A Location header.

Frequently the action performed by the POST method might not result in a resource that can be identified by a URI. In this case, either HTTP 200 OK or 204 No Content are an appropriate response status. Responses to this method are not cacheable, unless the response includes the appropriate Cache-Control or Expires header fields.

Note that POST is neither safe nor idempotent and invoking two identical POST requests results in two different resources containing the same information (except resource IDs).

Post Data Into LU Table

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

Component Description Mandatory Example Default
Domain name Domain name Y 10.21.1.69  
PORT PORT Y 3213  
api API Y api  
VERSION_NO Version number N V1.4 Latest version
LU Name Logical unit name or COMMON for common tables Y CUSTOMER COMMON  
Iid Instance ID Y 1  
token API Key Y    
format Response format Y JSON/XML JSON

Example:

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

    Insert data into CUSTOMER LU instance id 1, LION table

    Request Body

  {"rows" : {"LION" : [{"ID":11, "NAME":"lion11"},{"ID":12, "NAME":"lion12"},{"ID":13, "NAME":"lion13"}]}}

Post Data Into Common Table

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

Component Description Mandatory Example Default
Domain name Domain name Y 10.21.1.69  
PORT PORT Y 3213  
api API Y api  

schema

Reference table schema name

N

A valid schema name

common if empty

Example:

  • http://10.21.1.69:3213/api/v1.0/COMMON?REF_NAMES&token=ABC&format=json

    Insert data into common table REF_NAMES

    Request Body

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

Post Authenticate

  • http://<Domain name>:<PORT>/api/[VERSION_NO]/authenticate

    Generate a JWT digital signed cookie for Web-Services calls on the same session. Next Fabric Web-services calls will not require a token as a parameter. Located under fabric category.

Component Description Mandatory Example Default
Domain name Domain name Y 10.21.1.69  
PORT PORT Y 3213  
api API Y api  

Example:

`http://10.21.1.69:3213/api/v1.0/authenticate

  • Authenticate by apikey (token)

    Request Body

{
  "apikey": "string"
}
  • Authenticate by user/password

    Request Body

{
  "username": "string",
  "password": "string",
}

Post Fabric Commands

  • http://<Domain name>:<PORT>/api/[VERSION_NO]/fabric-commands

    Run fabric command or a set of fabric commands. Located under fabric category.

Component Description Mandatory Example Default
Domain name Domain name Y 10.21.1.69  
PORT PORT Y 3213  
api API Y api  

Example:

`http://10.21.1.69:3213/api/v1.0/fabric-commands

Request Body

{
    "commands": [
        {
            "command":"list ?",
            "params":['lut']

        }
    ]
 }

Response Body

{
  "results": [
    {
      "resultSet": {
        "columns": [
          "LU_NAME"
        ],
        "rows": [
          [
            "Customer"
          ],
          [
            "CRM"
          ]
        ]
      }
    }
  ]
}

Post Custom Web Service

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

Parameters should be populated in the body in the following structure:

{
“parameter name 1”:”value”,
“parameter name 2”:”value”
}
Component Description Mandatory Example Default
Domain name Domain name Y 10.21.1.69  
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  
Format Response format Y JSON/XML JSON

Request Header

Parameter Mandatory Value
Token Y API Key
Accept Y Json/XML/RAW
Any additional parameters N Parameter=value& Can be provided on both URL and header

Example:

  • http://10.21.1.69:3213/api/v1.0/Orders/1/Open?token=ABC&format=json

    In the body request put:

{
 "i_order_id": "1",
 "i_order_status": "Open"
}
  • Call Web Service Orders and bring output structure in JSON format according to input parameters i_order_id=1 and i_order_status=Open.

Previous

Post Verb

Use POST APIs to create new subordinate resources. For example, a file that is subordinate to the directory containing it, or a row that is subordinate to a database table.

Strictly in terms of REST, POST methods can be used to create a new resource in a collection of resources.

Ideally, if a resource has been created on the origin server, the response code SHOULD be HTTP 201 Created and contain:

  • An entity describing the request's status.
  • A reference to the new resource.
  • A Location header.

Frequently the action performed by the POST method might not result in a resource that can be identified by a URI. In this case, either HTTP 200 OK or 204 No Content are an appropriate response status. Responses to this method are not cacheable, unless the response includes the appropriate Cache-Control or Expires header fields.

Note that POST is neither safe nor idempotent and invoking two identical POST requests results in two different resources containing the same information (except resource IDs).

Post Data Into LU Table

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

Component Description Mandatory Example Default
Domain name Domain name Y 10.21.1.69  
PORT PORT Y 3213  
api API Y api  
VERSION_NO Version number N V1.4 Latest version
LU Name Logical unit name or COMMON for common tables Y CUSTOMER COMMON  
Iid Instance ID Y 1  
token API Key Y    
format Response format Y JSON/XML JSON

Example:

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

    Insert data into CUSTOMER LU instance id 1, LION table

    Request Body

  {"rows" : {"LION" : [{"ID":11, "NAME":"lion11"},{"ID":12, "NAME":"lion12"},{"ID":13, "NAME":"lion13"}]}}

Post Data Into Common Table

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

Component Description Mandatory Example Default
Domain name Domain name Y 10.21.1.69  
PORT PORT Y 3213  
api API Y api  

schema

Reference table schema name

N

A valid schema name

common if empty

Example:

  • http://10.21.1.69:3213/api/v1.0/COMMON?REF_NAMES&token=ABC&format=json

    Insert data into common table REF_NAMES

    Request Body

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

Post Authenticate

  • http://<Domain name>:<PORT>/api/[VERSION_NO]/authenticate

    Generate a JWT digital signed cookie for Web-Services calls on the same session. Next Fabric Web-services calls will not require a token as a parameter. Located under fabric category.

Component Description Mandatory Example Default
Domain name Domain name Y 10.21.1.69  
PORT PORT Y 3213  
api API Y api  

Example:

`http://10.21.1.69:3213/api/v1.0/authenticate

  • Authenticate by apikey (token)

    Request Body

{
  "apikey": "string"
}
  • Authenticate by user/password

    Request Body

{
  "username": "string",
  "password": "string",
}

Post Fabric Commands

  • http://<Domain name>:<PORT>/api/[VERSION_NO]/fabric-commands

    Run fabric command or a set of fabric commands. Located under fabric category.

Component Description Mandatory Example Default
Domain name Domain name Y 10.21.1.69  
PORT PORT Y 3213  
api API Y api  

Example:

`http://10.21.1.69:3213/api/v1.0/fabric-commands

Request Body

{
    "commands": [
        {
            "command":"list ?",
            "params":['lut']

        }
    ]
 }

Response Body

{
  "results": [
    {
      "resultSet": {
        "columns": [
          "LU_NAME"
        ],
        "rows": [
          [
            "Customer"
          ],
          [
            "CRM"
          ]
        ]
      }
    }
  ]
}

Post Custom Web Service

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

Parameters should be populated in the body in the following structure:

{
“parameter name 1”:”value”,
“parameter name 2”:”value”
}
Component Description Mandatory Example Default
Domain name Domain name Y 10.21.1.69  
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  
Format Response format Y JSON/XML JSON

Request Header

Parameter Mandatory Value
Token Y API Key
Accept Y Json/XML/RAW
Any additional parameters N Parameter=value& Can be provided on both URL and header

Example:

  • http://10.21.1.69:3213/api/v1.0/Orders/1/Open?token=ABC&format=json

    In the body request put:

{
 "i_order_id": "1",
 "i_order_status": "Open"
}
  • Call Web Service Orders and bring output structure in JSON format according to input parameters i_order_id=1 and i_order_status=Open.

Previous