Configuration of external presentations admin API Resource

System parameters handling WS

GET /api/admin/externalpresentations

Get list of configurations for external presentations

Response Body
media type data type description
application/json object (JSON) JSON Response with list of configurations for external presentations

Example of response:

{"list":[{"id":"1","description":"configuration description","parentClass":"parent class name","domainName":"Domain name"}]}

Example

Request
GET /api/admin/externalpresentations
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

POST /api/admin/externalpresentations

Add configuration for external presentation.

Example of request:

{"description":"Description","parentClassLabel":"Parent Class Label","parentClassId":10,"domainId":1,"domainName":"Domain Name","url4GetQuerries":"https://host/api/v2/floor/function/getpossiblequeries","url4QueryCall":"https://host/api/v2/floor/function/ExecuteQuery?cadkey={GUID}&queryid={queryId}&format=fmaccess"}

Request Body
media type data type description
application/json string (JSON) The specification of configuration that has to be added.
Response Body
media type data type description
application/json HdcSuccessWithId (JSON) JSON with added configuration ID.

{"id":"1","success":true}

Example

Request
POST /api/admin/externalpresentations
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{ }

DELETE /api/admin/externalpresentations/{configId}

Delete configuration of external presentation.

Request Parameters
name type description constraints
configId path ID of configuration to be deleted long
Response Body
media type data type description
application/json HdcSuccessTO (JSON) JSON with information about operation's result

Example

Request
DELETE /api/admin/externalpresentations/{configId}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{ }

GET /api/admin/externalpresentations/{configId}

Get configuration for external presentation by its id

Request Parameters
name type description constraints
configId path long
Response Body
media type data type description
application/json ExternalPresentationConfig (JSON) JSON Response with configuration for external presentation by its id

Example of response:

{"id":1,"description":"Description","parentClassLabel":"Parent Class Label","parentClassId":10,"domainId":1,"domainName":"Domain Name","url4GetQuerries":"https://host/api/v2/floor/function/getpossiblequeries","url4QueryCall":"https://host/api/v2/floor/function/ExecuteQuery?cadkey={GUID}&queryid={queryId}&format=fmaccess"}

Example

Request
GET /api/admin/externalpresentations/{configId}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "id" : 12345,
  "parentClassId" : 12345,
  "password" : "...",
  "userName" : "...",
  "childClassId" : 12345,
  "domainName" : "...",
  "parentClassLabel" : "...",
  "domainId" : 12345,
  "childClassLabel" : "...",
  "url4QueryCall" : "...",
  "childClassName" : "...",
  "description" : "...",
  "url4GetQueries" : "..."
}

PUT /api/admin/externalpresentations/{configId}

Update configuration for external presentation.

Example of request:

{"id":1,"description":"Description","parentClassLabel":"Parent Class Label","parentClassId":10,"domainId":1,"domainName":"Domain Name","url4GetQuerries":"https://host/api/v2/floor/function/getpossiblequeries","url4QueryCall":"https://host/api/v2/floor/function/ExecuteQuery?cadkey={GUID}&queryid={queryId}&format=fmaccess"}

Request Parameters
name type description constraints
configId path long
Request Body
media type data type description
application/json string (JSON) The specification of configuration that has to be updated.
Response Body
media type data type description
application/json HdcSuccessTO (JSON) JSON with information about operation's result

Example

Request
PUT /api/admin/externalpresentations/{configId}
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{ }