[Index]
Model ref.: relation/GS_FAC_REL
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{ "$schema": "http://json-schema.org/draft-03/schema", "type": "object", "properties": { "authorizationLevel": { "title": "Authorization Level", "minItems": 1, "required": true, "default": 0, "maxItems": 1, "type": "integer" }, "code": { "title": "Code", "minItems": 1, "required": true, "maxItems": 1, "maxLength": 16, "type": "string" }, "name": { "title": "Name", "minItems": 1, "required": true, "maxItems": 1, "maxLength": 50, "type": "string" }, "facHelpModel": { "type": "object", "properties": { "helpText": { "type": "string", "title": "Help Text" }, "name": { "default": "default", "type": "string", "title": "Name" } }, "title": "Fac Help Model" }, "facDataModel": { "type": "object", "properties": { "authorizationLevel": { "type": "string", "title": "Authorization Level" }, "code": { "pattern": "^[0-9]*$", "type": "string", "description": "Code can be from 1 to 16 digits in length.", "title": "Code" }, "name": { "type": "string", "title": "Name" } }, "title": "Fac Data Model" } }, "schema_version": "1.0" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/relation/GS_FAC_REL/add/ |
|
The GUI Add form of relation/GS_FAC_REL as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Create | POST | /api/relation/GS_FAC_REL/ | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk delete [pkid1],[pkid2]... | DELETE | /api/relation/GS_FAC_REL/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/GS_FAC_REL/[pkid1]", "/api/relation/GS_FAC_REL/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/GS_FAC_REL/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=relation/GS_FAC_REL |
|
{"hrefs": ["/api/relation/GS_FAC_REL/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=relation/GS_FAC_REL |
|
{"hrefs": ["/api/relation/GS_FAC_REL/[pkid1]", "/api/relation/GS_FAC_REL/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/GS_FAC_REL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/GS_FAC_REL/export/ |
|
{ "hrefs":["/api/relation/GS_FAC_REL/[pkid1]", "/api/relation/GS_FAC_REL/[pkid2]",...]}} |
For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip Content-Language:en Content-Type:application/x-zip
For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
The XLSX format can be used to bulk load instances of relation/GS_FAC_REL and the JSON format can be used to import instances of relation/GS_FAC_REL.
GET http://[host-proxy]/api/relation/GS_FAC_REL/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for relation/GS_FAC_REL | POST | /api/relation/GS_FAC_REL/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Configuration Template | GET | /api/relation/GS_FAC_REL/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/relation/GS_FAC_REL/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Migration Template | GET | /api/relation/GS_FAC_REL/migration/ |
|
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/relation/GS_FAC_REL/ |
|
The relation/GS_FAC_REL schema and all instances as JSON. |
(The list will return 0 to 3 relation/GS_FAC_REL instances)
{ "operations": [ "field_display_policy", "configuration_template", "help", "get", "clone", "move", "list", "update", "remove", "bulk_update", "add", "tag", "export", "migration", "export_bulkload_template", "tag_version" ], "pagination": { "direction": "asc", "order_by": "name", "maximum_limit": 2000, "skip": 0, "current": "/api/relation/GS_FAC_REL/?skip=0&limit=3&order_by=name&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 0 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": {}, "schema_version": "1.0", "references": { "device": [ { "pkid": "", "href": "" } ], "self": [ { "pkid": null, "href": "/api/relation/GS_FAC_REL/None/" } ], "children": [], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "add": { "support_async": false, "class": "add", "href": "/api/relation/GS_FAC_REL/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/relation/GS_FAC_REL/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=relation/GS_FAC_REL", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/relation/GS_FAC_REL/export/?hierarchy=[hierarchy]", "method": "POST", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "export_bulkload_template": { "support_async": false, "class": "bulkload_template", "href": "/api/relation/GS_FAC_REL/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "tag": { "title": "Tag", "support_async": true, "method": "PATCH", "href": "/api/relation/GS_FAC_REL/+tag/?hierarchy=[hierarchy]", "class": "tag", "view": "/api/view/TagNameForm/add/?auth_token=[authtoken] } }, { "tag_version": { "title": "Tag Version", "support_async": true, "method": "PATCH", "href": "/api/relation/GS_FAC_REL/+tag_version/?hierarchy=[hierarchy]", "class": "tag_version", "view": "/api/view/TagVersionForm/add/?auth_token=[authtoken] } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/relation/GS_FAC_REL/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/relation/GS_FAC_REL/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "migration": { "support_async": false, "class": "migration", "href": "/api/relation/GS_FAC_REL/migration/?hierarchy=[hierarchy]", "method": "GET", "title": "Migration Template" } }, { "list": { "support_async": false, "class": "list", "href": "/api/relation/GS_FAC_REL/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/relation/GS_FAC_REL/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } } ], "model_type": "relation/GS_FAC_REL", "model_specific_actions": [ "field_display_policy", "configuration_template", "help", "get", "clone", "move", "list", "update", "remove", "add", "tag", "export", "migration", "export_bulkload_template", "tag_version" ], "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "code", "title": "Code" }, { "name": "authorizationLevel", "title": "Authorization Level" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "resources": [] }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for relation/GS_FAC_REL. | GET | /api/relation/GS_FAC_REL/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/GS_FAC_REL as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/relation/GS_FAC_REL/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/relation/GS_FAC_REL/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/relation/GS_FAC_REL/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/relation/GS_FAC_REL/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=relation/GS_FAC_REL | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a selected [export_format] of the schema and a single instance with [pkid] of relation/GS_FAC_REL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/GS_FAC_REL/[pkid]/export/ |
|
The response is an attachment. Refer to the list below. |
For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=json, the response is a time stamped zip file of data in JSON and a response format:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip Content-Language:en Content-Type:application/x-zip
The XLSX format can be used to bulk load instances of relation/GS_FAC_REL and the JSON format can be used to import instances of relation/GS_FAC_REL.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Tag | PATCH | /api/relation/GS_FAC_REL/[pkid]/+tag/ | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/relation/GS_FAC_REL/[pkid]/ | hierarchy=[hierarchy] | The relation/GS_FAC_REL instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/relation/GS_FAC_REL/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/GS_FAC_REL. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Delete All Instances | POST | /api/relation/GS_FAC_REL/[pkid]/+deleteAllInstances/ | hierarchy=[hierarchy] | If payload required: |