Administer REST API
These are the GFC API specifications for the documents published through the REST API service.
To determine the GFC base URL, see Identifying a GFC base URL for REST API.
DSV Rest sending
URL: https://<BaseURL>/api/service/dsv/input
Method: POST
These are the specifications for requests:
| Request | Identifier | Type | Description |
|---|---|---|---|
| Query Parameter | tenantId | String | GFC tenant ID |
| lid | String | Sending application’s logical ID | |
| Body | inputFile | MultipartFile | file attachment for CSV or EBCIDIC |
These are the specifications for response:
| Response | Status Code | Content Type | Description |
|---|---|---|---|
| Success | 200 | JSON | Message, “Document/s successfully sent to GFC.” |
| Error | 400 | JSON |
The message depends on the error category. Invalid request. Total file size of the request has exceeded 1 MB. |
| 500 | JSON | Message, “An error occurred, please contact your system administrator.” |
Send Bod REST API service
URL: https://<BaseURL>/GFC/api/service/bod/send
Method: POST
These are the specifications for request messages:
| Request | Identifier | Type | Description |
|---|---|---|---|
| Parameter | tenantId | String | GFC tenant ID |
| Body | bods | MultipartFile | BOD xml file/s. Total size not more than 1MB. |
These are the specifications for response messages:
| Response | Status Code | Content Type | Description |
|---|---|---|---|
| Success | 200 | JSON | Message, “BODs successfully sent to GFC.” |
| Error | 400 | JSON | The message depends on the error category. Invalid request. No attached file with key bods. Total file size of the request has exceeded 1 MB. |
| 500 | JSON | Message, “An error occurred, please contact your system administrator.” |
Single Retrieve BOD REST API service
URL: https://<BaseURL>/GFC/api/service/bod/retrieve
Method: GET
These are the specifications for request messages:
| Request | Identifier | Type | Description |
|---|---|---|---|
| Parameter | lid | String | logical ID |
| tenantId | String | GFC tenant ID | |
| integrationName | String | intergration name |
These are the specifications for response messages:
| Response | Status Code | Content Type | Description |
|---|---|---|---|
| Success | 200 | Text XML | XML BOD |
| Error | 400 | JSON | The message depends on the error category. No record found. Invalid request. |
| 500 | JSON | Message, “An error occurred, please contact your system administrator.” |
Bulk Retrieve BOD REST API service
URL: https://<BaseURL>/GFC/api/service/bod/bulkretrieve
Method: GET
These are the specifications for request messages:
| Request | Identifier | Type | Description |
|---|---|---|---|
| Parameter | lid | String | logical ID |
| tenantId | String | GFC tenant ID | |
| integrationName | String | intergration name |
These are the specifications for response messages:
| Response | Status Code | Content Type | Description |
|---|---|---|---|
| Success | 200 | Text XML | List of String of BOD XML |
| Error | 400 | JSON | The message depends on the error category. No record found. Invalid request. |
| 500 | JSON | Message, “An error occurred, please contact your system administrator.” |
Synchronous REST API service – rule specific
URL: https://<BaseURL>/GFC/api/service/bod/generateOutput
Method: POST
These are the specifications for request messages:
| Request | Identifier | Type | Description |
|---|---|---|---|
| Query Parameter | ruleName | String | Rule Name |
| tenantId | String | GFC tenant ID | |
| scenarioName | String | Scenario Name | |
| integrationName | String | integration name | |
| Header Parameter | TransactionId | String | Transaction Id |
| Body | bods | MultipartFile | Bod xml/s Note: For Document Reference BODs it should be added on the same request with same identifier(bods). |
These are the specifications for response messages:
| Response | Status Code | Content Type | Description |
|---|---|---|---|
| Success | 200 | JSON | List of String of BOD XML |
| Error | 400 | JSON | The message depends on the error category. Invalid request. No attached file with key bods. Transaction Id already exists. Invalid file format. Request files must only contain XML documents. |
| 500 | JSON | Message, “An error occurred, please contact your system administrator.” |
- Authentication type = OAuth 1.0
- Signature Method = HMAC-SHA256
Provide the valid consumer key and consumer secret on the request.
Troubleshooting
| Status | Message | Additional Information | How to investigate and troubleshoot |
|---|---|---|---|
| 400 Bad Request | Invalid request | An error was encountered during processing of the request which does not have a
specific error category. An example would be when an integration name is not defined in the request. |
Review that the request parameter fields, and body exist or have a
valid value in your application request. After making the necessary corrections, retrigger the request from your application. |
| 401 Unauthorized | Access to service is denied. | Authentication keys being used by the client application is different from the web service security keys defined in GFC. | |
| 500 Internal server error | An error occurred, please contact your system administrator. | An error was encountered during processing of the request which does not have a
specific error category. An example is a server error. |
Retrigger the request from your application. |