Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

GUI Application Framework Endpoints

 

Use the references for REST API V9.0 GUI application framework endpoints.

GET /gui_app_framework/application_creation_task

Retrieves the status of all application installs.

Table 1: GET /gui_app_framework/application_creation_task Resource Details

MIME Type

application/json

Table 2: GET /gui_app_framework/application_creation_task Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

Range

header

Optional

String

text/plain

Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.

filter

query

Optional

String

text/plain

Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.

fields

query

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3: GET /gui_app_framework/application_creation_task Response Codes

HTTP Response Code

Unique Code

Description

200

 

Status list was retrieved.

422

22608

Invalid filter criteria supplied.

422

22609

Only top-level-elements of the root entity can be sorted on.

422

22610

The selected field cannot be used for sorting.

500

1020

The request could not be completed.

Response Description

A list of installation status details. For a description of what each list entry contains, see /application_creation_task/{application_id}.

Response Sample

[ { "application_id": 1001, "status": "ERROR", "error_messages": "Failed to start Docker container for application." }, { "application_id": 1002, "status": "CREATING" } ]

POST /gui_app_framework/application_creation_task

Initiates the asynchronous installation of a new application within the Application framework.

The returned application identifier should be used in subsequent API calls for that application.

Table 4: POST /gui_app_framework/application_creation_task Resource Details

MIME Type

application/json

Table 5: POST /gui_app_framework/application_creation_task Request Body Details

Parameter

Data Type

MIME Type

Description

Sample

package

zip

application/zip

Required - A zip file that contains the application's manifest and source code files.

null

Table 6: POST /gui_app_framework/application_creation_task Response Codes

HTTP Response Code

Unique Code

Description

201

 

The installation of the application was initiated successfully.

409

1008

An application with that UUID is already installed.

422

1005

The provided application is invalid.

500

1020

The request could not be completed.

Response Description

Installation status details:

  • application_id - Integer - Application identifier.

  • status - String

    • CREATING - the install is in progress.

    • ERROR - the install failed. The reason is in error_messages.

    • AUTH_REQUIRED - the install is waiting for a response to an authorisation request. See /application_creation_task/{application_id}/auth for details.

  • error_messages - String - Error messages, if status is ERROR.

Response Sample

{ "application_id": 1001, "status": "CREATING" }

GET /gui_app_framework/application_creation_task/{application_id}/auth

Retrieves an authorisation request for an application install.

Table 7: GET /gui_app_framework/application_creation_task/{application_id}/auth Resource Details

MIME Type

application/json

Table 8: GET /gui_app_framework/application_creation_task/{application_id}/auth Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

application_id

path

Required

Number (Integer)

text/plain

Required - The application identifier.

Table 9: GET /gui_app_framework/application_creation_task/{application_id}/auth Response Codes

HTTP Response Code

Unique Code

Description

200

 

Authorisation request was retrieved.

404

1002

The application identifier could not be found, or no authorisation request exists for the given application identifier.

500

1020

The request could not be completed.

Response Description

Authorisation request details:

  • capabilities - Array of String - List of capabilities being requested.

Response Sample

{ "capabilities": ["SEM", "EventViewer"] }

POST /gui_app_framework/application_creation_task/{application_id}/auth

Responds to an authorisation request for an application install.

The GET operation on /application_creation_task/{application_id}/auth returns the capabilities that were requested by the app and that can be supplied to this call.

The supplied capabilities list may contain all or a subset of the requested capabilities, but it may not contain any other capabilities. At least one capability must be supplied.

Table 10: POST /gui_app_framework/application_creation_task/{application_id}/auth Resource Details

MIME Type

application/json

Table 11: POST /gui_app_framework/application_creation_task/{application_id}/auth Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

application_id

path

Required

Number (Integer)

text/plain

Required - The application identifier.

Table 12: POST /gui_app_framework/application_creation_task/{application_id}/auth Request Body Details

Parameter

Data Type

MIME Type

Description

Sample

authorisation

Object

application/json

Required - The granted authorisation:

  • capabilities - Array of String - List of granted capabilities.

  • user_id - Long - user ID to be associated with this application.

{ "capabilities": ["SEM", "EventViewer"], "user_id": 1 }

Table 13: POST /gui_app_framework/application_creation_task/{application_id}/auth Response Codes

HTTP Response Code

Unique Code

Description

200

 

Authorisation was granted.

404

1002

The application identifier could not be found, or no authorisation request exists for the given application identifier.

409

1008

The provided authorisation values conflict with those in the original request.

422

1005

The provided authorisation values are not valid.

500

1020

The request could not be completed.

Response Description

Confirmation of the granted authorisation:

  • capabilities - Array of String - List of granted capabilities.

  • user_id - Long - Associated user ID.

Response Sample

{ "capabilities": ["SEM", "EventViewer"], "user_id": 1 }

GET /gui_app_framework/application_creation_task/{application_id}

Retrieve a list of status details of a asynchronous request to create application.

Table 14: GET /gui_app_framework/application_creation_task/{application_id} Resource Details

MIME Type

application/json

Table 15: GET /gui_app_framework/application_creation_task/{application_id} Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

application_id

path

Required

Number (Integer)

text/plain

Required - Get the status details of this application defined by application_id returned by the initial POST on application_creation_task.

Table 16: GET /gui_app_framework/application_creation_task/{application_id} Response Codes

HTTP Response Code

Unique Code

Description

200

 

Application Creation Request list was retrieved.

404

1002

The application_id is invalid or could not be found.

500

1020

An error occurred while attempting to retrieve the list of status details.

Response Description

The details of the request to create application.

Response Sample

[ { "application_id":"101", "status":"String <one of: CREATING, UPGRADING, COMPLETED, CANCELLED, ERROR>", "error_messages": [ { "code":"String <one of: ERROR_DB_UNAVAILABLE, ERROR_FRAMEWORK_UNAVAILABLE, ERROR_CREATING_IMAGE, ERROR_STARTING_CONTAINER>", "message":"String" } ] } ]

POST /gui_app_framework/application_creation_task/{application_id}

Cancels the installation of an application within the Application framework.

Table 17: POST /gui_app_framework/application_creation_task/{application_id} Resource Details

MIME Type

application/json

Table 18: POST /gui_app_framework/application_creation_task/{application_id} Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

application_id

path

Required

Number (Integer)

text/plain

Required - The application identifier.

status

query

Required

String

text/plain

Required - "CANCELLED".

Table 19: POST /gui_app_framework/application_creation_task/{application_id} Response Codes

HTTP Response Code

Unique Code

Description

200

 

The application installation was cancelled.

404

1002

The application identifier could not be found.

409

1008

The install is in a state that cannot be cancelled.

422

1005

Status is invalid.

500

1020

The request could not be completed.

Response Description

Installation status details:

  • application_id - Integer - Application identifier.

  • status - String - "CANCELLED".

Response Sample

{ "application_id": 1001, "status": "CREATING" }

GET /gui_app_framework/applications

Retrieves a list of all installed applications.

Retrieved details include the application manifest and current status.

Table 20: GET /gui_app_framework/applications Resource Details

MIME Type

application/json

There are no parameters for this endpoint.

Table 21: GET /gui_app_framework/applications Response Codes

HTTP Response Code

Unique Code

Description

200

 

Application list was retrieved.

500

1020

The request could not be completed.

Response Description

A list of application details. For a description of what each list entry contains, see GET /applications/{application_id}.

Response Sample

[ { "application_state":{ "application_id":"1001", "status":"RUNNING", "error_message":"", "memory":200 }, "manifest":{ "name":"Sample Application", "description":"An example of how to create an application manifest", "version":"0.0.1", "areas": [ { "id":"Qapp1_HelloWorld", "url":"http://9.21.118.58:5000", "text":"QApp1", "description":"Loading a dockerised web app into a tab inside Qradar", "required_capabilities":["ADMIN"] } ], "dashboard_items": [ { "text":"Sample Item", "description":"Sample dashboard item that is a copy of most recent offenses", "rest_method":"sampleDashboardItem", "required_capabilities":["ADMIN"] } ], "rest_methods": [ { "name":"sampleDashboardItem", "url":"/static/sampleDashboardItemResponse.json", "method":"GET", "argument_names":[], "required_capabilities":["ADMIN"] }, { "name":"sampleToolbarMethod", "url":"/static/sampleToolbarButtonResponse.json", "method":"GET", "argument_names":["context"], "required_capabilities":["ADMIN"] }, { "name":"sampleIPInformation", "url":"/static/sampleIPInformationResponse.json", "method":"GET", "argument_names":["metaDataContext"], "required_capabilities":["ADMIN"] }, { "name":"sampleUserInformation", "url":"/static/sampleUserInformationResponse.json", "method":"GET", "argument_names":["metaDataContext"], "required_capabilities":["ADMIN"] }, { "name":"sampleURLInformation", "url":"/static/sampleURLInformationResponse.json", "method":"GET", "argument_names":["metaDataContext"], "required_capabilities":["ADMIN"] }, { "name":"addToReferenceSet", "url":"/addToReferenceSet", "method":"GET", "argument_names":["data"] } ], "configuration_pages": [ { "text":"Open IBM.com", "description":"Loading IBM.com in a new window", "icon":null, "url":"https://www.ibm.com/us/en/", "required_capabilities":["ADMIN"] } ], "gui_actions": [ { "id":"addToReferenceSet", "text":"Add To Reference Set", "description":"Adds to a reference set", "icon":null, "rest_method":"addToReferenceSet", "javascript":"alert(result)", "groups":[ "ipPopup" ], "required_capabilities":[ "ADMIN" ] }, { "id":"sampleToolbarButton", "text":"Sample Toolbar Button", "description":"Sample toolbar button that calls a REST method, passing an offense ID along", "icon":null, "rest_method":"sampleToolbarMethod", "javascript":"alert(result)", "groups":[ "OffenseListToolbar" ], "required_capabilities":[ "ADMIN" ] } ], "page_scripts": [ { "app_name":"SEM", "page_id":"OffenseList", "scripts":["/static/sampleScriptInclude.js"] } ], "metadata_providers": [ { "rest_method":"sampleIPInformation", "metadata_type":"ip" }, { "rest_method":"sampleUserInformation", "metadata_type":"userName" }, { "rest_method":"sampleURLInformation", "metadata_type":"ariel:URL" } ] } } ]

GET /gui_app_framework/applications/{application_id}

Retrieve an installed application.

Retrieved details include the application manifest and current status.

Table 22: GET /gui_app_framework/applications/{application_id} Resource Details

MIME Type

application/json

Table 23: GET /gui_app_framework/applications/{application_id} Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

application_id

path

Required

Number (Integer)

text/plain

Required - The application identifier.

Table 24: GET /gui_app_framework/applications/{application_id} Response Codes

HTTP Response Code

Unique Code

Description

200

 

The application was retrieved.

404

1002

The application identifier could not be found.

500

1020

The request could not be completed.

Response Description

Application details:

  • application_state

    • application_id - String - Application identifier.

    • status - String

      • CREATING - the application install has not yet completed.

      • UPGRADING - the application upgrade has not yet completed.

      • RUNNING - the application is running.

      • STOPPED - the application has been stopped manually.

      • ERROR - the application is no longer running due to an error. The reason is in error_message.

    • error_message - String - Any error message associated with the application.

    • memory - Integer - The amount of memory allocated to the application

  • manifest - Object - The application's JSON manifest.

Response Sample

{ "application_state":{ "application_id":"1001", "status":"RUNNING", "error_message":"", "memory":200 }, "manifest":{ "name":"Sample Application", "description":"An example of how to create an application manifest", "version":"0.0.1", "areas": [ { "id":"Qapp1_HelloWorld", "url":"http://9.21.118.58:5000", "text":"QApp1", "description":"Loading a dockerised web app into a tab inside Qradar", "required_capabilities":["ADMIN"] } ], "dashboard_items": [ { "text":"Sample Item", "description":"Sample dashboard item that is a copy of most recent offenses", "rest_method":"sampleDashboardItem", "required_capabilities":["ADMIN"] } ], "rest_methods": [ { "name":"sampleDashboardItem", "url":"/static/sampleDashboardItemResponse.json", "method":"GET", "argument_names":[], "required_capabilities":["ADMIN"] }, { "name":"sampleToolbarMethod", "url":"/static/sampleToolbarButtonResponse.json", "method":"GET", "argument_names":["context"], "required_capabilities":["ADMIN"] }, { "name":"sampleIPInformation", "url":"/static/sampleIPInformationResponse.json", "method":"GET", "argument_names":["metaDataContext"], "required_capabilities":["ADMIN"] }, { "name":"sampleUserInformation", "url":"/static/sampleUserInformationResponse.json", "method":"GET", "argument_names":["metaDataContext"], "required_capabilities":["ADMIN"] }, { "name":"sampleURLInformation", "url":"/static/sampleURLInformationResponse.json", "method":"GET", "argument_names":["metaDataContext"], "required_capabilities":["ADMIN"] }, { "name":"addToReferenceSet", "url":"/addToReferenceSet", "method":"GET", "argument_names":["data"] } ], "configuration_pages": [ { "text":"Open IBM.com", "description":"Loading IBM.com in a new window", "icon":null, "url":"https://www.ibm.com/us/en/", "required_capabilities":["ADMIN"] } ], "gui_actions": [ { "id":"addToReferenceSet", "text":"Add To Reference Set", "description":"Adds to a reference set", "icon":null, "rest_method":"addToReferenceSet", "javascript":"alert(result)", "groups":[ "ipPopup" ], "required_capabilities":[ "ADMIN" ] }, { "id":"sampleToolbarButton", "text":"Sample Toolbar Button", "description":"Sample toolbar button that calls a REST method, passing an offense ID along", "icon":null, "rest_method":"sampleToolbarMethod", "javascript":"alert(result)", "groups":[ "OffenseListToolbar" ], "required_capabilities":[ "ADMIN" ] } ], "page_scripts": [ { "app_name":"SEM", "page_id":"OffenseList", "scripts":["/static/sampleScriptInclude.js"] } ], "metadata_providers": [ { "rest_method":"sampleIPInformation", "metadata_type":"ip" }, { "rest_method":"sampleUserInformation", "metadata_type":"userName" }, { "rest_method":"sampleURLInformation", "metadata_type":"ariel:URL" } ] } }

POST /gui_app_framework/applications/{application_id}

Updates an application.

Supply status=RUNNING to start a stopped application.

Supply status=STOPPED to stop a running application.

Supply oauth_user_id to change the OAuth user associated with the application.

Table 25: POST /gui_app_framework/applications/{application_id} Resource Details

MIME Type

application/json

Table 26: POST /gui_app_framework/applications/{application_id} Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

application_id

path

Required

Number (Integer)

text/plain

Required - The application identifier.

status

query

Optional

String

text/plain

- The status to set: RUNNING or STOPPED.

oauth_user_id

query

Optional

Number (Integer)

text/plain

- The OAuth user ID to set. This parameter is ignored when status is supplied.

Table 27: POST /gui_app_framework/applications/{application_id} Response Codes

HTTP Response Code

Unique Code

Description

200

 

The application has been successfully updated.

404

1002

The application identifier could not be found.

409

1008

The application is in a state that does not allow the requested update.

422

1005

A supplied parameter is invalid.

500

1020

The request could not be completed.

Response Description

Application details, see GET /applications/{application_id}.

Response Sample

{ "application_state":{ "application_id":"1001", "status":"RUNNING", "error_message":"", "memory":200 }, "manifest":{ "name":"Sample Application", "description":"An example of how to create an application manifest", "version":"0.0.1", "areas": [ { "id":"Qapp1_HelloWorld", "url":"http://9.21.118.58:5000", "text":"QApp1", "description":"Loading a dockerised web app into a tab inside Qradar", "required_capabilities":["ADMIN"] } ], "dashboard_items": [ { "text":"Sample Item", "description":"Sample dashboard item that is a copy of most recent offenses", "rest_method":"sampleDashboardItem", "required_capabilities":["ADMIN"] } ], "rest_methods": [ { "name":"sampleDashboardItem", "url":"/static/sampleDashboardItemResponse.json", "method":"GET", "argument_names":[], "required_capabilities":["ADMIN"] }, { "name":"sampleToolbarMethod", "url":"/static/sampleToolbarButtonResponse.json", "method":"GET", "argument_names":["context"], "required_capabilities":["ADMIN"] }, { "name":"sampleIPInformation", "url":"/static/sampleIPInformationResponse.json", "method":"GET", "argument_names":["metaDataContext"], "required_capabilities":["ADMIN"] }, { "name":"sampleUserInformation", "url":"/static/sampleUserInformationResponse.json", "method":"GET", "argument_names":["metaDataContext"], "required_capabilities":["ADMIN"] }, { "name":"sampleURLInformation", "url":"/static/sampleURLInformationResponse.json", "method":"GET", "argument_names":["metaDataContext"], "required_capabilities":["ADMIN"] }, { "name":"addToReferenceSet", "url":"/addToReferenceSet", "method":"GET", "argument_names":["data"] } ], "configuration_pages": [ { "text":"Open IBM.com", "description":"Loading IBM.com in a new window", "icon":null, "url":"https://www.ibm.com/us/en/", "required_capabilities":["ADMIN"] } ], "gui_actions": [ { "id":"addToReferenceSet", "text":"Add To Reference Set", "description":"Adds to a reference set", "icon":null, "rest_method":"addToReferenceSet", "javascript":"alert(result)", "groups":[ "ipPopup" ], "required_capabilities":[ "ADMIN" ] }, { "id":"sampleToolbarButton", "text":"Sample Toolbar Button", "description":"Sample toolbar button that calls a REST method, passing an offense ID along", "icon":null, "rest_method":"sampleToolbarMethod", "javascript":"alert(result)", "groups":[ "OffenseListToolbar" ], "required_capabilities":[ "ADMIN" ] } ], "page_scripts": [ { "app_name":"SEM", "page_id":"OffenseList", "scripts":["/static/sampleScriptInclude.js"] } ], "metadata_providers": [ { "rest_method":"sampleIPInformation", "metadata_type":"ip" }, { "rest_method":"sampleUserInformation", "metadata_type":"userName" }, { "rest_method":"sampleURLInformation", "metadata_type":"ariel:URL" } ] } }

PUT /gui_app_framework/applications/{application_id}

Upgrade an application.

Table 28: PUT /gui_app_framework/applications/{application_id} Resource Details

MIME Type

application/json

Table 29: PUT /gui_app_framework/applications/{application_id} Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

application_id

path

Required

Number (Integer)

text/plain

null

Table 30: PUT /gui_app_framework/applications/{application_id} Request Body Details

Parameter

Data Type

MIME Type

Description

Sample

package

zip

application/zip

A zip file, that contains custom code, and a application manifest JSON file descriptor

null

Table 31: PUT /gui_app_framework/applications/{application_id} Response Codes

HTTP Response Code

Unique Code

Description

202

 

The request for an application upgrade was accepted.

404

1002

The application_id is invalid or could not be found.

409

1008

The application is locked by another process.

422

1005

The provided application is invalid. See messages for further details.

500

1020

The application could not be created.

Response Description

application id and status

Response Sample

[ { "application_id":"101", "status":"String <one of: CREATING, UPGRADING, COMPLETED, CANCELLED, ERROR>", "error_messages": [ { "code":"String <one of: ERROR_DB_UNAVAILABLE, ERROR_FRAMEWORK_UNAVAILABLE, ERROR_CREATING_IMAGE, ERROR_STARTING_CONTAINER>", "message":"String" } ] } ]

DELETE /gui_app_framework/applications/{application_id}

Deletes an Application.

Table 32: DELETE /gui_app_framework/applications/{application_id} Resource Details

MIME Type

text/plain

Table 33: DELETE /gui_app_framework/applications/{application_id} Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

application_id

path

Required

Number (Integer)

text/plain

Required - The application identifier.

Table 34: DELETE /gui_app_framework/applications/{application_id} Response Codes

HTTP Response Code

Unique Code

Description

204

 

The application has been successfully deleted.

404

1002

The application identifier could not be found.

409

1008

The application is in a state that cannot be deleted.

500

1020

The request could not be completed.

Response Description

Successful response code 204 No content.

Response Sample

GET /gui_app_framework/named_services

Retrieves a list of all named services registered with the Application Framework.

By using the returned information, the caller can determine what services are available and what facilities each service provides via its REST endpoints.

Table 35: GET /gui_app_framework/named_services Resource Details

MIME Type

application/json

There are no parameters for this endpoint.

Response Description

Table 36: GET /gui_app_framework/named_services Response Codes

HTTP Response Code

Unique Code

Description

200

 

The list of named services was returned.

500

1020

An error occurred while trying to retrieve the list of named services.

A list of named services. The documentation for /named_services/{uuid} has a description of the details returned for a named service instance.

Response Sample

[{ "name": "resourceservice", "version": "1", "application_id": 1001, "uuid": "e4081cd1-c3c8-4089-afc7-c32039bd796c", "endpoints": [ { "name": "getResource", "path": "https://1.1.1.1/console/plugins/1001/ app_proxy:resourceservice/resource/{resource_id}", "http_method": "GET", "parameters": [ { "location": "PATH", "name": "resource_id" } ], "response": { "mime_type": "application/json+ld", "body_type": { "@type": "http://id.ibm.com/Resource", "resource_id": "http://id.ibm.com/resourceID", "resource_name": "http://id.ibm.com/resourceName", "resource_owner": "http://id.ibm.com/personId" } }, "error_mime_type": "text/plain" }, { "name": "createResource", "path": "https://1.1.1.1/console/plugins/1001/ app_proxy:resourceservice/resource", "http_method": "POST", "request_mime_type": "application/json+ld", "request_body_type": { "@type": "http://id.ibm.com/Resource", "resource_name": "http://id.ibm.com/resourceName", "resource_owner": "http://id.ibm.com/personId" }, "response": { "mime_type": "application/json+ld", "body_type": { "@type": "http://id.ibm.com/Resource", "resource_id": "http://id.ibm.com/resourceID", "resource_name": "http://id.ibm.com/resourceName", "resource_owner": "http://id.ibm.com/personId" } }, "error_mime_type": "text/plain" }, { "name": "updateResource", "path": "https://1.1.1.1/console/plugins/1001/ app_proxy:resourceservice/resource/{resource_id}", "http_method": "PUT", "request_mime_type": "application/json+ld", "request_body_type": { "@type": "http://id.ibm.com/Resource", "resource_name": "http://id.ibm.com/resourceName", "resource_owner": "http://id.ibm.com/personId" }, "parameters": [ { "location": "PATH", "name": "resource_id" } ], "response": { "mime_type": "application/json+ld", "body_type": { "@type": "http://id.ibm.com/Resource", "resource_id": "http://id.ibm.com/resourceID", "resource_name": "http://id.ibm.com/resourceName", "resource_owner": "http://id.ibm.com/personId" } }, "error_mime_type": "text/plain" } ] }]

GET /gui_app_framework/named_services/{uuid}

Retrieves a named service registered with the Application Framework by using the supplied uuid.

Table 37: GET /gui_app_framework/named_services/{uuid} Resource Details

MIME Type

application/json

Table 38: GET /gui_app_framework/named_services/{uuid} Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

uuid

path

Required

String

text/plain

Required - A named service uuid.

Response Description

Table 39: GET /gui_app_framework/named_services/{uuid} Response Codes

HTTP Response Code

Unique Code

Description

200

 

The requested named service was returned.

404

1002

The requested named service could not be found.

500

1020

An error occurred while trying to retrieve the requested named service.

The details of a named service:

  • name - String - Service name.

  • version - String - Service version.

  • application_id - Integer - ID of the application that implements this service.

  • uuid - Integer - Unique identifier for this service.

  • endpoints - Array - List of endpoints provided by this service.

    • name - String - Endpoint name.

    • path - String - Endpoint URL.

    • http_method - String - One of GET/POST/PUT/DELETE.

    • request_mime_type - String - MIME type of request body.

    • request_body_type - Object - JSON definition of request body.

    • parameters - Array - List of request parameters.

      • location - String - Where the parameter goes in the request. One of PATH/QUERY/BODY.

    • name - String - Parameter name.

    • definition - String - Parameter definition, e.g. "String".

    • response - Object - Response definition.

      • mime_type - String - MIME type of response body.

      • body_type - Object - JSON definition of response body.

    • error_mime_type - String - MIME type of response body when an error occurs.

Response Sample

{ "name": "resourceservice", "version": "1", "application_id": 1001, "uuid": "e4081cd1-c3c8-4089-afc7-c32039bd796c", "endpoints": [ { "name": "getResource", "path": "https://1.1.1.1/console/plugins/1001/ app_proxy:resourceservice/resource/{resource_id}", "http_method": "GET", "parameters": [ { "location": "PATH", "name": "resource_id" } ], "response": { "mime_type": "application/json+ld", "body_type": { "@type": "http://id.ibm.com/Resource", "resource_id": "http://id.ibm.com/resourceID", "resource_name": "http://id.ibm.com/resourceName", "resource_owner": "http://id.ibm.com/personId" } }, "error_mime_type": "text/plain" }, { "name": "createResource", "path": "https://1.1.1.1/console/plugins/1001/ app_proxy:resourceservice/resource", "http_method": "POST", "request_mime_type": "application/json+ld", "request_body_type": { "@type": "http://id.ibm.com/Resource", "resource_name": "http://id.ibm.com/resourceName", "resource_owner": "http://id.ibm.com/personId" }, "response": { "mime_type": "application/json+ld", "body_type": { "@type": "http://id.ibm.com/Resource", "resource_id": "http://id.ibm.com/resourceID", "resource_name": "http://id.ibm.com/resourceName", "resource_owner": "http://id.ibm.com/personId" } }, "error_mime_type": "text/plain" }, { "name": "updateResource", "path": "https://1.1.1.1/console/plugins/1001/ app_proxy:resourceservice/resource/{resource_id}", "http_method": "PUT", "request_mime_type": "application/json+ld", "request_body_type": { "@type": "http://id.ibm.com/Resource", "resource_name": "http://id.ibm.com/resourceName", "resource_owner": "http://id.ibm.com/personId" }, "parameters": [ { "location": "PATH", "name": "resource_id" } ], "response": { "mime_type": "application/json+ld", "body_type": { "@type": "http://id.ibm.com/Resource", "resource_id": "http://id.ibm.com/resourceID", "resource_name": "http://id.ibm.com/resourceName", "resource_owner": "http://id.ibm.com/personId" } }, "error_mime_type": "text/plain" } ] }

Related Documentation