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
-
apiLabel(required): string
Minimum Length:
1
Maximum Length:255
The label used to identify the API. -
label(required): string
Minimum Length:
1
Maximum Length:255
The unique identifier of the application.
The collection of API access entities that are updated for the specified application.
Root Schema : Application
Type:
object
Title:
Show Source
Application
-
activityFields:
array Activity Fields
Title:
Activity Fields
The activity fields of the API that are assigned to the application. The activity fields are only available for Inbound API. -
apiEntities:
array API Entities
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. -
apiMethods:
array API Methods
Title:
API Methods
The methods of the API that are assigned to the application. The API Method fields are only applicable for Capacity API. -
inventoryFields:
array Inventory Fields
Title:
Inventory Fields
The inventory fields of the API that are assigned to the application. The inventory fields are only applicable for Inbound Interface API. -
providerFields:
array Provider Fields
Title:
Provider Fields
The provider fields of the API that are assigned to the application. The provider fields are only applicable for Inbound Interface API. -
requestFields:
array Request Fields
Title:
Request Fields
The request fields are not applicable for any API. -
status:
string
Title:
Status
Allowed Values:[ "active", "inactive" ]
The status of the application. -
userFields:
array User Fields
Title:
User Fields
The user fields are not applicable for any API.
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 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 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 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 Inbound Interface API.
Show Source
Nested Schema : Request Fields
Type:
array
Title:
Request Fields
The request fields are not applicable for any API.
Show Source
Nested Schema : User Fields
Type:
array
Title:
User Fields
The user fields are not applicable for any API.
Show Source
Nested Schema : ApplicationApiAccessContext
Type:
Show Source
object
-
label:
string
Minimum Length:
1
Maximum Length:255
The label of the activity property. -
valuesVisibility:
array valuesVisibility
The visibility settings for each property.
-
visibilities:
array visibilities
The visibility settings for each field.
Nested Schema : items
Type:
Show Source
object
-
conditions:
array ApplicationApiAccessContextConditions
-
value:
string
The value set for the property.
Nested Schema : items
Type:
Show Source
object
-
function(required):
string
Allowed Values:
[ "in", "not_in", "contains", "dcontain", "is_null", "is_not_null" ]
The function used by the condition to display the property. -
label(required):
string
Minimum Length:
1
Maximum Length:40
The label of the property specified for the application. -
value:
string
The value used by the condition to test a function.
-
valueList:
array valueList
The list of values used by the condition to test a function.
Nested Schema : valueList
Type:
array
The list of values used by the condition to test a function.
Show Source
Nested Schema : items
Type:
Show Source
object
-
conditions:
array ApplicationApiAccessContextConditions
-
visibility:
string
Allowed Values:
[ "ReadOnly", "ReadWrite", "Mandatory" ]
The visibility settings defined for an activity field.
Nested Schema : ApplicationApiAccessEntity
Type:
Show Source
object
-
access:
string
Allowed Values:
[ "ReadOnly", "ReadWrite", "Hidden" ]
The visibility set for the entity. -
label:
string
Minimum Length:
1
Maximum Length:80
The label of the entity.
Nested Schema : ApplicationApiAccessMethod
Type:
Show Source
object
-
label:
string
Minimum Length:
1
Maximum Length:80
The label of the API method. -
status:
string
Allowed Values:
[ "on", "off" ]
The status of the API method.
Nested Schema : ApplicationApiAccessContextUser
Type:
Show Source
object
-
label:
string
Minimum Length:
1
Maximum Length:255
The label of the user property. -
visibilities:
array visibilities
Nested Schema : visibilities
Type:
Show Source
array
-
Array of:
object items
The collection of visibility settings for the property.
Nested Schema : items
Type:
object
The collection of visibility settings for the property.
Show Source
-
visibility:
string
Allowed Values:
[ "ReadOnly", "ReadWrite", "Mandatory" ]
The visibility value assigned to the property.
Response
Supported Media Types
- application/json
- application/schema+json
200 Response
This section describes the 200 status response for this operation.
Root Schema : Application
Type:
object
Title:
Show Source
Application
-
activityFields:
array Activity Fields
Title:
Activity Fields
The activity fields of the API that are assigned to the application. The activity fields are only available for Inbound API. -
apiEntities:
array API Entities
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. -
apiMethods:
array API Methods
Title:
API Methods
The methods of the API that are assigned to the application. The API Method fields are only applicable for Capacity API. -
inventoryFields:
array Inventory Fields
Title:
Inventory Fields
The inventory fields of the API that are assigned to the application. The inventory fields are only applicable for Inbound Interface API. -
providerFields:
array Provider Fields
Title:
Provider Fields
The provider fields of the API that are assigned to the application. The provider fields are only applicable for Inbound Interface API. -
requestFields:
array Request Fields
Title:
Request Fields
The request fields are not applicable for any API. -
status:
string
Title:
Status
Allowed Values:[ "active", "inactive" ]
The status of the application. -
userFields:
array User Fields
Title:
User Fields
The user fields are not applicable for any API.
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 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 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 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 Inbound Interface API.
Show Source
Nested Schema : Request Fields
Type:
array
Title:
Request Fields
The request fields are not applicable for any API.
Show Source
Nested Schema : User Fields
Type:
array
Title:
User Fields
The user fields are not applicable for any API.
Show Source
Nested Schema : ApplicationApiAccessContext
Type:
Show Source
object
-
label:
string
Minimum Length:
1
Maximum Length:255
The label of the activity property. -
valuesVisibility:
array valuesVisibility
The visibility settings for each property.
-
visibilities:
array visibilities
The visibility settings for each field.
Nested Schema : items
Type:
Show Source
object
-
conditions:
array ApplicationApiAccessContextConditions
-
value:
string
The value set for the property.
Nested Schema : items
Type:
Show Source
object
-
function(required):
string
Allowed Values:
[ "in", "not_in", "contains", "dcontain", "is_null", "is_not_null" ]
The function used by the condition to display the property. -
label(required):
string
Minimum Length:
1
Maximum Length:40
The label of the property specified for the application. -
value:
string
The value used by the condition to test a function.
-
valueList:
array valueList
The list of values used by the condition to test a function.
Nested Schema : valueList
Type:
array
The list of values used by the condition to test a function.
Show Source
Nested Schema : items
Type:
Show Source
object
-
conditions:
array ApplicationApiAccessContextConditions
-
visibility:
string
Allowed Values:
[ "ReadOnly", "ReadWrite", "Mandatory" ]
The visibility settings defined for an activity field.
Nested Schema : ApplicationApiAccessEntity
Type:
Show Source
object
-
access:
string
Allowed Values:
[ "ReadOnly", "ReadWrite", "Hidden" ]
The visibility set for the entity. -
label:
string
Minimum Length:
1
Maximum Length:80
The label of the entity.
Nested Schema : ApplicationApiAccessMethod
Type:
Show Source
object
-
label:
string
Minimum Length:
1
Maximum Length:80
The label of the API method. -
status:
string
Allowed Values:
[ "on", "off" ]
The status of the API method.
Nested Schema : ApplicationApiAccessContextUser
Type:
Show Source
object
-
label:
string
Minimum Length:
1
Maximum Length:255
The label of the user property. -
visibilities:
array visibilities
Nested Schema : visibilities
Type:
Show Source
array
-
Array of:
object items
The collection of visibility settings for the property.
Nested Schema : items
Type:
object
The collection of visibility settings for the property.
Show Source
-
visibility:
string
Allowed Values:
[ "ReadOnly", "ReadWrite", "Mandatory" ]
The visibility value assigned to the property.
Default Response
This section describes the default error response for this operation.
Root Schema : Error
Type:
Show Source
object
-
detail:
string
The detailed description of this error.
-
status:
string
The HTTP status code of this error.
-
title(required):
string
The brief description of this error.
-
type(required):
string
The URL of the web page containing more details about this error.
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>.fs.ocs.oraclecloud.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>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/applications/26d6378878056c53ebb9c44b0db598c867586ab8/apiAccess/core_api" }, { "rel": "describedby", "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/applications/apiAccess/core_api" } ] }