Get all device tokens
get
/crmRestApi/resources/11.13.18.05/deviceTokens
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- AltKey Finds a device token using the party ID or device token.
Finder Variables- DeviceToken; string; The device token associated with a registered device.
- PartyId; integer; The party ID associated with the token.
- DevTokenPartyIdFinder Finds a device token by party ID or device token.
Finder Variables- DeviceToken; string; The device token used to search.
- PartyId; integer; The party ID associated with the token used to search for device token.
- PrimaryKey Finds a device token with the specified primary key.
Finder Variables- DeviceTokenId; integer; The unique identification number of the device token.
- AltKey Finds a device token using the party ID or device token.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- ApplicationName; string; The application name of the device token.
- CreatedBy; string; The user who created the device token.
- CreationDate; string; The date when the device token was created.
- DeviceToken; string; The device token associated with a registered device.
- DeviceTokenId; integer; The unique identifier of the device token.
- DeviceTokenTypeCd; string; The type of device that's being registered with the device token.
- LastUpdateDate; string; The date when the device token was last updated.
- LastUpdateLogin; string; The login details of the user who last updated the device token.
- LastUpdatedBy; string; The user who last updated the device token.
- PartyId; integer; The party associated with device token.
- PartyName; string; The party name associated with device token.
- UpsertMode; string; Indicates if the device token can be updated.
- UserAgent; string; The user agent associated with the device.
- UserGUID; string; The user ID associated with the device token.
- UserName; string; The user name associated with the device token.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : deviceTokens
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : deviceTokens-item-response
Type:
Show Source
object
-
ApplicationName: string
Maximum Length:
50
The application name of the device token. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the device token. -
CreationDate: string
(date-time)
Read Only:
true
The date when the device token was created. -
DeviceToken: string
Maximum Length:
1000
The device token associated with a registered device. -
DeviceTokenId: integer
(int64)
Read Only:
true
The unique identifier of the device token. -
DeviceTokenTypeCd: string
Maximum Length:
30
The type of device that's being registered with the device token. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the device token was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the device token. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of the user who last updated the device token. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyId: integer
(int64)
The party associated with device token.
-
PartyName: string
Maximum Length:
360
The party name associated with device token. -
UpsertMode: string
Indicates if the device token can be updated.
-
UserAgent: string
Maximum Length:
256
The user agent associated with the device. -
UserGUID: string
Read Only:
true
Maximum Length:64
The user ID associated with the device token. -
UserName: string
Maximum Length:
100
The user name associated with the device token.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.