Get API access for an application

get

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

This operation retrieves the API access information of an application based on the specified API label and the application ID specified while creating the application.

Request

Path Parameters
  • Minimum Length: 1
    Maximum Length: 255
    The label used to identify the API.
    Allowed Values: [ "partsCatalogAPI", "capacityAPI", "coreAPI", "inboundAPI", "gpsAPI", "historyAPI", "metadataAPI", "activityManagementAPI", "outboundAPI", "resourceManagementAPI", "smartLocationAPI", "statisticsAPI" ]
  • Minimum Length: 1
    Maximum Length: 255
    The label used to retrieve the API access information of the application.
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 Activity Management API or Inbound API specified in the request.
Show Source
Nested Schema : API Entities
Type: array
Title: API Entities
The entities of Core API or Metadata API specified in the request.
Show Source
Nested Schema : API Methods
Type: array
Title: API Methods
The methods of Activity Management API, Resource Management API, or Capacity API specified in the request.
Show Source
Nested Schema : Inventory Fields
Type: array
Title: Inventory Fields
The inventory fields of the Activity Management API or Inbound Interface API specified in the request.
Show Source
Nested Schema : Provider Fields
Type: array
Title: Provider Fields
The provider fields of the Resource Management API or Inbound Interface API specified in the request.
Show Source
Nested Schema : Request Fields
Type: array
Title: Request Fields
The request fields of the Activity Management API specified in the request.
Show Source
Nested Schema : User Fields
Type: array
Title: User Fields
The user fields of the Resource Management API specified in the request.
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

Example 1

The following example shows how to retrieve API access (based on entity fields visibilities) by submitting a GET request on the REST resource using cURL:

cURL Command Example

curl -u 'clientId@instance:clientSecret' \
 -X GET \
 --url 'https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/applications/5afbd589dd6042de63507621940f2f3a4a477fb6/apiAccess/activityManagementAPI'

Response Body for Example 1

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
{
    "label": "activityManagementAPI",
    "name": "Activity Management API",
    "status": "active",
    "apiMethods": [
        {
            "label": "cancel_activity",
            "status": "on"
        },
        {
            "label": "complete_activity",
            "status": "on"
        },
        {
            "label": "create_activity",
            "status": "on"
        },
        {
            "label": "create_customer_inventory",
            "status": "on"
        },
        {
            "label": "create_customer_request",
            "status": "on"
        },
        {
            "label": "create_inventory_request",
            "status": "on"
        },
        {
            "label": "create_resource_inventory",
            "status": "on"
        },
        {
            "label": "create_resource_request",
            "status": "on"
        },
        {
            "label": "deinstall_inventory",
            "status": "off"
        },
        {
            "label": "delay_activity",
            "status": "on"
        },
        {
            "label": "delete_file",
            "status": "on"
        },
        {
            "label": "delete_inventory",
            "status": "off"
        },
        {
            "label": "end_route",
            "status": "off"
        },
        {
            "label": "exchange_inventory",
            "status": "off"
        },
        {
            "label": "get_activities",
            "status": "on"
        },
        {
            "label": "get_activity",
            "status": "on"
        },
        {
            "label": "get_activity_links",
            "status": "on"
        },
        {
            "label": "get_activity_work_skills",
            "status": "on"
        },
        {
            "label": "get_customer_inventory_list",
            "status": "off"
        },
        {
            "label": "get_customer_request_list",
            "status": "off"
        },
        {
            "label": "get_file",
            "status": "on"
        },
        {
            "label": "get_inventory",
            "status": "off"
        },
        {
            "label": "get_inventory_request_list",
            "status": "off"
        },
        {
            "label": "get_multiday_activities",
            "status": "off"
        },
        {
            "label": "get_multiday_activity_parts",
            "status": "off"
        },
        {
            "label": "get_request",
            "status": "off"
        },
        {
            "label": "get_required_inventories",
            "status": "off"
        },
        {
            "label": "get_resource_inventory_list",
            "status": "off"
        },
        {
            "label": "get_resource_preferences",
            "status": "off"
        },
        {
            "label": "get_resource_request_list",
            "status": "off"
        },
        {
            "label": "get_route",
            "status": "off"
        },
        {
            "label": "get_user",
            "status": "on"
        },
        {
            "label": "install_inventory",
            "status": "off"
        },
        {
            "label": "link_activities",
            "status": "off"
        },
        {
            "label": "prework_activity",
            "status": "off"
        },
        {
            "label": "reopen_activity",
            "status": "on"
        },
        {
            "label": "search_activities",
            "status": "on"
        },
        {
            "label": "set_file",
            "status": "on"
        },
        {
            "label": "set_required_inventories",
            "status": "off"
        },
        {
            "label": "set_resource_preferences",
            "status": "off"
        },
        {
            "label": "start_activity",
            "status": "off"
        },
        {
            "label": "start_route",
            "status": "off"
        },
        {
            "label": "suspend_activity",
            "status": "on"
        },
        {
            "label": "undo_deinstall_inventory",
            "status": "off"
        },
        {
            "label": "undo_install_inventory",
            "status": "off"
        },
        {
            "label": "unlink_activities",
            "status": "off"
        },
        {
            "label": "update_activity",
            "status": "on"
        },
        {
            "label": "update_inventory",
            "status": "off"
        }
    ],
    "activityFields": [
        {
            "label": "XA_SECTOR_CODE",
            "visibilities": [
                {
                    "visibility": "ReadWrite"
                }
            ]
        },
        {
            "label": "astatus",
            "visibilities": [
                {
                    "visibility": "Mandatory",
                    "conditions": [
                        {
                            "label": "XA_DEFECTS_1.10",
                            "function": "in",
                            "valueList": [
                                "test"
                            ]
                        }
                    ]
                }
            ],
            "valuesVisibility": [
                {
                    "value": "0",
                    "conditions": [
                        {
                            "label": "EL_COPY_TR_MATRIX",
                            "function": "in",
                            "valueList": [
                                "test"
                            ]
                        }
                    ]
                }
            ]
        }
    ],
    "inventoryFields": [
        {
            "label": "EL_OUT_INV_READING_POST_BS_6",
            "visibilities": [
                {
                    "visibility": "ReadWrite",
                    "conditions": [
                        {
                            "label": "XR_ACCREDITATION_APMR",
                            "function": "dcontain",
                            "value": "test"
                        }
                    ]
                }
            ]
        }
    ],
    "requestFields": [],
    "links": [
        {
            "rel": "canonical",
            "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/applications/5afbd589dd6042de63507621940f2f3a4a477fb6/apiAccess/activityManagementAPI"
        },
        {
            "rel": "describedby",
            "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/metadata-catalog/applications/apiAccess/activityManagementAPI"
        }
    ]
}

Example 2

The following example shows how to retrieve API access (based on entities) by submitting a GET request on the REST resource using cURL:

cURL Command Example

curl -u 'clientId@instance:clientSecret' \
 -X GET \
 --url 'https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/applications/5afbd589dd6042de63507621940f2f3a4a477fb6/apiAccess/metadataAPI'

Response for Example 2

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
{
    "label": "metadataAPI",
    "name": "Metadata API",
    "status": "active",
    "apiEntities": [
        {
            "label": "metadata_api_activity_type",
            "access": "Hidden"
        },
        {
            "label": "metadata_api_applications",
            "access": "ReadWrite"
        },
        {
            "label": "metadata_api_capacity_area",
            "access": "Hidden"
        },
        {
            "label": "metadata_api_capacity_category",
            "access": "Hidden"
        },
        {
            "label": "metadata_api_map_layers",
            "access": "Hidden"
        },
        {
            "label": "metadata_api_non_working_reasons",
            "access": "Hidden"
        },
        {
            "label": "metadata_api_organizations",
            "access": "Hidden"
        },
        {
            "label": "metadata_api_property",
            "access": "Hidden"
        },
        {
            "label": "metadata_api_work_skill",
            "access": "Hidden"
        },
        {
            "label": "metadata_api_workzone",
            "access": "Hidden"
        }
    ],
    "links": [
        {
            "rel": "canonical",
            "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/applications/5afbd589dd6042de63507621940f2f3a4a477fb6/apiAccess/metadata_api"
        },
        {
            "rel": "describedby",
            "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/metadata-catalog/applications/apiAccess/metadata_api"
        }
    ]
}
Back to Top