-
-
Notifications
You must be signed in to change notification settings - Fork 60
v1 DynamicsWebApi.RetrieveRequest
DynamicsWebApi.RetrieveRequest
-
↳
RetrieveRequest
- async
- collection
- expand
- id
- ifmatch
- ifnonematch
- impersonate
- impersonateAAD
- includeAnnotations
- key
- metadataAttributeType
- navigationProperty
- navigationPropertyKey
- noCache
- partitionId
- savedQuery
- select
- skipNameCheck
- timeout
- token
- userQuery
• Optional async: boolean
XHR requests only! Indicates whether the requests should be made synchronously or asynchronously.Default value is 'true'(asynchronously).
• Optional collection: string
The name of the Entity Collection or Entity Logical name.
• Optional expand: Expand[]
An array of Expand Objects(described below the table) representing the $expand OData System Query Option value to control which related records are also returned.
• Optional id: string
Deprecated
Use "key" instead. A String representing the Primary Key(GUID) of the record.
• Optional ifmatch: string
Sets If-Match header value that enables to use conditional retrieval or optimistic concurrency in applicable requests.
• Optional ifnonematch: string
Sets If-None-Match header value that enables to use conditional retrieval in applicable requests.
• Optional impersonate: string
Impersonates the user.A String representing the GUID value for the Dynamics 365 system user id.
• Optional impersonateAAD: string
Impersonates the user.A String representing the GUID value for the Azure active directory object id.
• Optional includeAnnotations: string
Sets Prefer header with value "odata.include-annotations=" and the specified annotation.Annotations provide additional information about lookups, options sets and other complex attribute types.
• Optional key: string
A String representing collection record's Primary Key (GUID) or Alternate Key(s).
• Optional metadataAttributeType: string
v.1.4.3 + Casts the AttributeMetadata to a specific type. (Used in requests to Attribute Metadata).
• Optional navigationProperty: string
A String representing the name of a single - valued navigation property.Useful when needed to retrieve information about a related record in a single request.
• Optional navigationPropertyKey: string
v.1.4.3 + A String representing navigation property's Primary Key (GUID) or Alternate Key(s). (For example, to retrieve Attribute Metadata).
• Optional noCache: boolean
If set to 'true', DynamicsWebApi adds a request header 'Cache-Control: no-cache'.Default value is 'false'.
• Optional partitionId: string
v.1.7.7+ A unique partition key value of a logical partition for non-relational custom entity data stored in NoSql tables of Azure heterogenous storage.
• Optional savedQuery: string
A String representing the GUID value of the saved query.
• Optional select: string[]
An Array(of Strings) representing the $select OData System Query Option to control which attributes will be returned.
• Optional skipNameCheck: boolean
Skips the collection name check in DynamicsWebApi.
• Optional timeout: number
Sets a number of milliseconds before a request times out.
• Optional token: string
Authorization Token. If set, onTokenRefresh will not be called.
• Optional userQuery: string
A String representing the GUID value of the user query.