REST API:applicationAccess Resource

From AT&T Support Wiki

Manage Application Access records using the REST API.

Learn more: REST API Conventions and Considerations.

Permissions

Users that have the Access Control permission can use this resource.

List Application Access Records

Method

GET

URI

https://{domain}/networking/rest/applicationAccess

Response

<platform>
    <applicationAccess>
         ...
    </applicationAccess>

    <applicationAccess>
         ...
    </applicationAccess>
     ...

    <message>
        <code>0</code>
        <description>Success</description>
    </message>
    <recordCount>N</recordCount>      <!-- Number of __ records returned -->
</platform>

See also: REST API:Error Codes

Get an Application Access Record

Method

GET

URI

https://{domain}/networking/rest/applicationAccess/{applicationId}

Response

<platform>
    <applicationAccess>
        <access>
            <accessTo>
            <type>USER</type>
            <roles>
                <role>...{roleId}...</role>
                ...
            </roles>
        </access>

    </applicationAccess>

    <message>
        <code>0</code>
        <description>Success</description>
    </message>
</platform>

See also: REST API:Error Codes

Add an Application Access Record

Method

POST

URI

https://{domain}/networking/rest/applicationAccess

Request

<platform>
    <applicationAccess>
        ...
    </applicationAccess>
</platform>

Response

<platform>
    <message>
        <code>0</code>
        <description>Success</description>
        <id>...</id>   <!-- ID of the newly created applicationAccess -->
    </message>
</platform>

See also: REST API:Error Codes

Update an Application Access Record

Method

PUT

URI

https://{domain}/networking/rest/applicationAccess/{recordId}

Request

<platform>
    <applicationAccess>
         ...
    </applicationAccess>
</platform>

Response

<platform>
    <message>
        <code>0</code>
        <description>Success</description>
    </message>
</platform>

See also: REST API:Error Codes

Delete an Application Access Record

Method

DELETE

URI

https://{domain}/networking/rest/applicationAccess/{recordId}

Response

<platform>
    <message>
        <code>0</code>
        <description>Success</description>
    </message>
</platform>

See also: REST API:Error Codes

Dynamic Search for Application Access Records

Method

GET

URI

https://{domain}/networking/rest/applicationAccess?{query_parameters}

Query Parameters

• fieldList - A comma-separated list of field names to retrieve

• The asterisk (*) wildcard specifies all fields
• Use the REST API:field Resource to get a complete list of fields
• Field lists for database views need to specify the object's alias, as well as the field name.

• filter - Filtering criteria to filter the records

• For more examples, see Filter Expressions in REST APIs and the REST API Examples.)

• pageSize - Number of records to retrieve from the result set in order to make a "page".
• page - Number of the logical page in a database result set. The first page is page "zero" (0).

Page zero is returned by default, so appending &pageSize=1 to your query returns a single record.

• getTotalRecordCount returns the number of total records.
  Causes the following structure to be returned, where N is the total number of records:

<platform>
   ...
   <message>
      <code>0</code>
      <description>Success</description>
   </message>

   <!-- added by the query param -->
   <totalRecordCount>N</totalRecordCount>
</platform>

• sortBy - Field name for primary sort
  Ex: &sortBy=name
• sortOrder - Sort order of the primary field, either "asc" or "desc" (ascending or descending)
  Ex: &sortOrder="desc"
• sortBy2 - Field name for secondary sort
• sortOrder2 - Sort order of the second field, either "asc" or "desc" (ascending or descending)

For more information, see: Specifying Query Parameters in REST APIs

Response

<platform>
    ....
    <message>
        <code>0</code>
        <description>Success</description>
    </message>
</platform>

See also: REST API:Error Codes

Fields

Name	Type	Attribute	Default Value	Description	Additional Information
access	Tag			Specifies a user who can access the application
date_modified	Date	Read Only			UTC Format
date_created	Date	Read Only			UTC Format
created_id	Lookup	Read Only			User ID
modified_id	Lookup	Read Only			User ID

access

Name	Type	Attribute	Required on Add	Description
accessTo	String			Specifies a user who can access the application
roles	String			Specifies the roles they can assume

Error Codes

Platform Code	with Http Status	Description
-7000	BAD_REQUEST (400)	Invalid ID

Learn more:

• See the REST API:Error Codes for common Http error codes
• See the javadoc constants for a complete list of PlatformException error-code constants.