View source for REST API:applicationAccess Resource

Manage Application Access records using the [[REST API]].

:''Learn more:'' REST API [[REST API#Conventions and Considerations|Conventions and Considerations]].

===Permissions===
{{PermissionRef|Access Control|use this resource.}}

===List Application Access Records===

;Method:GET
 
;URI:<tt><nowiki>https://{domain}/networking/rest/applicationAccess</nowiki></tt> 

;Response:
:<syntaxhighlight lang="xml" enclose="div">
<platform>
    <applicationAccess>
         ...
    </applicationAccess>

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

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

:See also: [[REST API:Error Codes]]

===Get an Application Access Record===
;Method:GET
 
;URI:<tt><nowiki>https://{domain}/networking/rest/applicationAccess/{applicationId}</nowiki></tt>

;Response:
:<syntaxhighlight lang="xml" enclose="div">
<platform>
    <applicationAccess>
        <access>
            <accessTo>
            <type>USER</type>
            <roles>
                <role>...{roleId}...</role>
                ...
            </roles>
        </access>

    </applicationAccess>

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

:See also: [[REST API:Error Codes]]

===Add an Application Access Record===

;Method:POST
 
;URI:<tt><nowiki>https://{domain}/networking/rest/applicationAccess</nowiki></tt> 

;Request:
:<syntaxhighlight lang="xml" enclose="div">
<platform>
    <applicationAccess>
        ...
    </applicationAccess>
</platform>
</syntaxhighlight>

;Response:
:<syntaxhighlight lang="xml" enclose="div">
<platform>
    <message>
        <code>0</code>
        <description>Success</description>
        <id>...</id>   <!-- ID of the newly created applicationAccess -->
    </message>
</platform>
</syntaxhighlight>

:See also: [[REST API:Error Codes]]

===Update an Application Access Record===
;Method:PUT
 
;URI:<tt><nowiki>https://{domain}/networking/rest/applicationAccess/{recordId}</nowiki></tt> 

;Request:
:<syntaxhighlight lang="xml" enclose="div">
<platform>
    <applicationAccess>
         ...
    </applicationAccess>
</platform>
</syntaxhighlight>

;Response:
:<syntaxhighlight lang="xml" enclose="div">
<platform>
    <message>
        <code>0</code>
        <description>Success</description>
    </message>
</platform>
</syntaxhighlight>

:See also: [[REST API:Error Codes]]

===Delete an Application Access Record ===

;Method:DELETE

;URI:<tt><nowiki>https://{domain}/networking/rest/applicationAccess/{recordId}</nowiki></tt>

;Response:
:<syntaxhighlight lang="xml" enclose="div">
<platform>
    <message>
        <code>0</code>
        <description>Success</description>
    </message>
</platform>
</syntaxhighlight>

:See also: [[REST API:Error Codes]]

===Dynamic Search for Application Access Records===
;Method:GET

;URI:<tt><nowiki>https://{domain}/networking/rest/applicationAccess?{query_parameters}</nowiki></tt>
{{:REST API:Dynamic Search}}

;Response:
:<syntaxhighlight lang="xml" enclose="div">
<platform>
    ....
    <message>
        <code>0</code>
        <description>Success</description>
    </message>
</platform>
</syntaxhighlight>

:See also: [[REST API:Error Codes]]

===Fields===

:{| border="1" cellpadding="5" cellspacing="0"
! Name !! Type !! Attribute !! Default Value !! Description !! Additional Information
|-
| access || Tag||  || || Specifies a user  who can access the application || 

|- 
| colspan="6"  bgcolor="Azure" style="height:7px" |  <!-- SPACER ROW -->

|-
| date_modified || Date || align="center"|Read Only || || || [[UTC Format]]
|-
| date_created || Date || align="center"|Read Only || || || [[UTC Format]]
|-
| created_id || Lookup || align="center"|Read Only  || || || [[REST API:User Resource|User]] ID
|-
| modified_id || Lookup || align="center"|Read Only || || || [[REST API:User Resource|User]] ID
|}

;access:
:{| border="1" cellpadding="5" cellspacing="0"
! 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===
:{| border="1" cellpadding="5" cellspacing="0"
! Platform Code||with Http Status||Description
|-
| align="center"| -7000 || BAD_REQUEST (400) || Invalid ID
|}

''Learn more:''
:* See the [[REST API:Error Codes]] for common Http error codes
:* See the [{{DOCHOST}}/javadocs/constant-values.html javadoc constants] for a complete list of <tt>PlatformException</tt> error-code constants.
<noinclude>

[[Category:REST API|applicationAccess Resource]]
</noinclude>