REST API:applicationAccess Resource

From AgileApps Support Wiki

Jump to: navigation, search

Manage Application Access records using the REST API.

Learn more: REST API Conventions and Considerations.

Contents

Permissions

Lock-tiny.gif

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}

Thumbsup.gif

Tip:
To get the id of application access record from the GUI, go to the Application Access page and modify the view to include the Record ID field.

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/{applicationId}
Request
<platform>
  <applicationAccess>
     <applicationId>...</applicationId>
     <accessTo>
        <type>USER</type>
        <id>...</id>
        <roles>
           <role>
              <id>...</id>
           </role>
           <role>
              ...
           </role>
            ...
        </roles>
     </accessTo>
     <accessTo>
        ...
     </accessTo>
      ...
  </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/{applicationId}
Request
<platform>
  <applicationAccess>
     <applicationId>...</applicationId>
     <accessTo>
        <type>USER</type>
        <id>...</id>
        <roles>
           <role>
              <id>...</id>
           </role>
           <role>
              ...
           </role>
            ...
        </roles>
     </accessTo>
     <accessTo>
        ...
     </accessTo>
      ...
  </applicationAccess>
</platform>
  • The application-access record for the specified application is updated.
  • New accessTo elements are added.
  • An accessTo element with a matching type and id is replaced.
(The list of roles specified in the update-record replaces the existing list of roles.)
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/{applicationId}/{respective UserId or TeamId}

Notepad.png

Note: The UserId or TeamId is the Id which you want to delete from Application Access for a specific User or Team.

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}
Example
List all records, and all of their fields:
https://{{domain}}/networking/rest/applicationAccess?fieldList=*
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
  • 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>
    <record>
        <id>8e657280c4a084857a212313e029c49</id>
        <application_id>0c848119d6a343d88a3302164fb41a1b</application_id>
        <created_id type="" ...
          uri="https://{{domain}}/networking/rest/user/3"
          displayValue=" System">3</created_id>
        <modified_id type=""
          uri="https://{{domain}}/networking/rest/user/3"
          displayValue=" System">3</modified_id>
        <date_modified>2012-07-02</date_modified>
        <date_created>2012-07-02</date_created>
    </record>
    <record>
      ...
    </record>
     ...
    <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
applicationId
String The ID of an application
applicationName String Read Only The application name
accessTo container
  type String The kind of entity granted access (user or team) Values:
USER or
TEAM
  id String The ID of the user or team
  name String Read Only The name of the User or Team
  roles Container
    role Container
      id String The ID of a role the user or team member can assume in the application
      name String Read Only The name of the role
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 Codewith Http StatusDescription
-7000 BAD_REQUEST (400) Invalid ID

Learn more:

Personal tools