REST API:applicationAccess Resource

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..

Get an Application Access Record

Method

GET

URI

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

Response

<platform>
  <applicationAccess>
     <applicationId>348f933bf0dc4bfeb5a8e8ade2bb145e</applicationId>
     <applicationName>Order Management</applicationName>
     <accessTo>
        <type>USER</type>
        <id>b2e935fc454a4c45815c3b0ffb0b9869</id>
        <name>Aaron Acme</name>
        <roles>
           <role>
              <id>7d74139597b945dd8b712084c61dae05</id>
              <name>Manager</name>
           </role>
           <role>
              ...
           </role>
            ...
        </roles>
     </accessTo>
     <accessTo>
        ...
     </accessTo>
      ...
  </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 record -->
    </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
• {fieldname} specifies an individual field (e.g. name)

(Use the REST API:field Resource to get a complete list of fields.)

• For a Composite Object, specify {alias}.{fieldname} to select a related-record field, where the alias is defined in the Object Relationships.
• For a Database View, specify {alias}.{fieldname}, where the object alias is defined in the Database View.
• alias.* specifies all fields in the aliased object.

• 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> 
   <status>
   <packageDeploy>
   ...
   </packageDeploy>
   </status>
   <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	Description	Additional Information
id	String		This record's ID
application_id	String		The ID of an application
reference_type	String		The kind of entity granted access (user or team)	Values: USER or TEAM
reference_id	String		The ID of the user or team
role_id	String		The ID of a role the user or team member can assume in 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

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.