GET system/applications/components/applicable-components

List components that the current logged in user has access to.

Note: Log in to check if your API client have access to run this resource
Version: 1
Success HTTP Status Code: 200
Maximum items from list ($top): 80

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold is required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$inlinecount String, optional Only usable when the result is a list. Set to "allpages" if you want size of the result list to be returned. Accepted values are: "allpages", "none"
$top String, optional Only usable when the result is a list. Set the number of objects to return in result list. Maximum limit is specific for each resource, but is default 80.
$filter String, optional Only usable when the result is a list. Use to filter the result list, see the Filter and OrderBy page for more information about this.
$orderby String, optional Only usable when the result is a list. Use to order the result list, see Filter and OrderBy page for more information about this.
$select String, optional Use to define the fields to return in the result. Accepts a comma-separated list of Output Field names. See the Expand and Select page for more information about this.
$db String, optional Set the database to use for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "json"
$lang String, optional Use to get localized responses. Supported formats are 3-letter ISO-639-1 [lll], 2-letter ISO-639-2 [ll], or a combination of a two-letter language code and a two-letter country code ISO-639-2 and ISO-3166-1 [ll_CC], [ll-CC]
$useMinimumVersion Integer, optional This can be used to test a new version of a resource when your ApiClient is running an older, deprecated, version of a resource. $useminimumversion can be used to test against a newer version of the resource. See the Deprecated APIs page for more information about this.

See the page about filters and sorting on how to use filter parameters and named filters.

ApplicationID String The identifier for the component.
ApplicationMatch String Matching Keyword.
Checksum String Checksum.
Description String The descriptive tag of an application or component.
Module String Type of HTML5 component. Used for widgets.
Name String Name of the component.
Status String Status of the component.

See the page about filters and sorting on how to use sortable parameters

ApplicationID String The identifier for the component
ApplicationMatch String Matching Keyword
Checksum String Checksum
Description String The descriptive tag of an application or component
Module String Type of HTML5 component. Used for widgets.
Name String Name of the component
Status String Status of the component

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<Components>
2
     <Component>
3
          <ApplicationID
ApplicationID

The identifier for the component

>
{String}</ApplicationID>
4
          <Status
Status

Status of the component

>
{String}</Status>
5
          <Name
Name

Name of the component

>
{String}</Name>
6
          <ApplicationMatch
ApplicationMatch

Matching Keyword

>
{String}</ApplicationMatch>
7
          <Checksum
Checksum

Checksum

>
{String}</Checksum>
8
          <Description
Description

The descriptive tag of an application or component

>
{String}</Description>
9
     </Component>
10
</Components>
1
{
2
     "components": [
3
          {
4
               "applicationID
ApplicationID

The identifier for the component

":
"{String}",
5
               "status
Status

Status of the component

":
"{String}",
6
               "name
Name

Name of the component

":
"{String}",
7
               "applicationMatch
ApplicationMatch

Matching Keyword

":
"{String}",
8
               "checksum
Checksum

Checksum

":
"{String}",
9
               "description
Description

The descriptive tag of an application or component

":
"{String}"
10
          }
11
     ]
12
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return: