Update API access for applications

patch

/rest/ofscMetadata/v1/applications/{label}/apiAccess/{apiLabel}

This operation updates the API access information of an application based on the specified API label and the application ID specified while creating the application. For example, this method can be used to enable Core API access for a specific application.

Request

Path Parameters
  • Minimum Length: 1
    Maximum Length: 255
    The label used to identify the API.
  • Minimum Length: 1
    Maximum Length: 255
    The unique identifier of the application.
Body ()
The collection of API access entities that are updated for the specified application.
Root Schema : Application
Type: object
Title: Application
Show Source
Nested Schema : Activity Fields
Type: array
Title: Activity Fields
The activity fields of the API that are assigned to the application. The activity fields are only available for Activity Management API and Inbound API.
Show Source
Nested Schema : API Entities
Type: array
Title: API Entities
The entities of the API that are assigned to the application. The API Entities fields are only applicable for Core API and Metadata API.
Show Source
Nested Schema : API Methods
Type: array
Title: API Methods
The methods of the API that are assigned to the application. The API Method fields are only applicable for Activity Management API, Resource Management API, and Capacity API.
Show Source
Nested Schema : Inventory Fields
Type: array
Title: Inventory Fields
The inventory fields of the API that are assigned to the application. The inventory fields are only applicable for Activity Management API and Inbound Interface API.
Show Source
Nested Schema : Provider Fields
Type: array
Title: Provider Fields
The provider fields of the API that are assigned to the application. The provider fields are only applicable for Resource Management API and Inbound Interface API.
Show Source
Nested Schema : Request Fields
Type: array
Title: Request Fields
The request fields of the API that are assigned to the application. The request fields are only applicable for Activity Management API.
Show Source
Nested Schema : User Fields
Type: array
Title: User Fields
The user fields of Resource Management API that are assigned to the application. The user fields are only applicable for Resource Management API.
Show Source
Nested Schema : ApplicationApiAccessContext
Type: object
Show Source
Nested Schema : valuesVisibility
Type: array
The visibility settings for each property.
Show Source
Nested Schema : visibilities
Type: array
The visibility settings for each field.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : ApplicationApiAccessContextConditions
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : valueList
Type: array
The list of values used by the condition to test a function.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : ApplicationApiAccessEntity
Type: object
Show Source
Nested Schema : ApplicationApiAccessMethod
Type: object
Show Source
Nested Schema : ApplicationApiAccessContextUser
Type: object
Show Source
Nested Schema : visibilities
Type: array
Show Source
Nested Schema : items
Type: object
The collection of visibility settings for the property.
Show Source
Back to Top

Response

Supported Media Types

200 Response

This section describes the 200 status response for this operation.
Body ()
Root Schema : Application
Type: object
Title: Application
Show Source
Nested Schema : Activity Fields
Type: array
Title: Activity Fields
The activity fields of the API that are assigned to the application. The activity fields are only available for Activity Management API and Inbound API.
Show Source
Nested Schema : API Entities
Type: array
Title: API Entities
The entities of the API that are assigned to the application. The API Entities fields are only applicable for Core API and Metadata API.
Show Source
Nested Schema : API Methods
Type: array
Title: API Methods
The methods of the API that are assigned to the application. The API Method fields are only applicable for Activity Management API, Resource Management API, and Capacity API.
Show Source
Nested Schema : Inventory Fields
Type: array
Title: Inventory Fields
The inventory fields of the API that are assigned to the application. The inventory fields are only applicable for Activity Management API and Inbound Interface API.
Show Source
Nested Schema : Provider Fields
Type: array
Title: Provider Fields
The provider fields of the API that are assigned to the application. The provider fields are only applicable for Resource Management API and Inbound Interface API.
Show Source
Nested Schema : Request Fields
Type: array
Title: Request Fields
The request fields of the API that are assigned to the application. The request fields are only applicable for Activity Management API.
Show Source
Nested Schema : User Fields
Type: array
Title: User Fields
The user fields of Resource Management API that are assigned to the application. The user fields are only applicable for Resource Management API.
Show Source
Nested Schema : ApplicationApiAccessContext
Type: object
Show Source
Nested Schema : valuesVisibility
Type: array
The visibility settings for each property.
Show Source
Nested Schema : visibilities
Type: array
The visibility settings for each field.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : ApplicationApiAccessContextConditions
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : valueList
Type: array
The list of values used by the condition to test a function.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : ApplicationApiAccessEntity
Type: object
Show Source
Nested Schema : ApplicationApiAccessMethod
Type: object
Show Source
Nested Schema : ApplicationApiAccessContextUser
Type: object
Show Source
Nested Schema : visibilities
Type: array
Show Source
Nested Schema : items
Type: object
The collection of visibility settings for the property.
Show Source

Default Response

This section describes the default error response for this operation.
Body ()
Root Schema : Error
Type: object
Error response
Show Source
Back to Top

Examples

The following example shows how to update API access level based on application label and API label by submitting a PATCH request on the REST resource using cURL:

cURL Command Example

curl -u 'clientId@instance:clientSecret' \
 -X PATCH \
 --url https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/applications/26d6378878056c53ebb9c44b0db598c867586ab8/apiAccess/coreAPI \
 --data-binary '{
    "status": "active",
    "apiEntities": [
        {
            "label": "core_api_activity",
            "access": "Hidden"
        }
    ]
}'

Response Header Example

The following shows an example of the response header.

HTTP/1.1 200 OK
Server: nginx
Date: Thu, 03 Mar 2016 16:28:18 GMT
Content-Type: application/json; charset=utf-8
Connection: close

Response Body Example

The following shows an example of the response body in JSON format.

{
    "label": "core_api",
    "name": "Core API",
    "status": "active",
    "apiEntities": [
        {
            "label": "core_api_activity",
            "access": "Hidden"
        },
        {
            "label": "core_api_collaboration",
            "access": "Hidden"
        },
        {
            "label": "core_api_dailyextract",
            "access": "Hidden"
        },
        {
            "label": "core_api_events",
            "access": "ReadWrite"
        },
        {
            "label": "core_api_inventory",
            "access": "Hidden"
        },
        {
            "label": "core_api_resource",
            "access": "Hidden"
        },
        {
            "label": "core_api_user",
            "access": "Hidden"
        }
    ],
    "links": [
        {
            "rel": "canonical",
            "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/applications/26d6378878056c53ebb9c44b0db598c867586ab8/apiAccess/core_api"
        },
        {
            "rel": "describedby",
            "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/metadata-catalog/applications/apiAccess/core_api"
        }
    ]
}
Back to Top