-
-
Notifications
You must be signed in to change notification settings - Fork 60
RetrieveRequest
-
↳
RetrieveRequest
- async
- collection
- expand
- headers
- ifmatch
- ifnonematch
- impersonate
- impersonateAAD
- inChangeSet
- includeAnnotations
- key
- metadataAttributeType
- navigationProperty
- navigationPropertyKey
- noCache
- partitionId
- queryParams
- savedQuery
- select
- signal
- timeout
- token
- userQuery
• Optional async: boolean
XHR requests only! Indicates whether the requests should be made synchronously or asynchronously.Default value is 'true'(asynchronously).
• collection: string
A 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 headers: HeaderCollection
Headers to supply with a request. These headers will override configuraiton headers if the identical ones were set.
• 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 a user based on their systemuserid by adding "MSCRMCallerID" header. A String representing the GUID value for the Dynamics 365 systemuserid.
• Optional impersonateAAD: string
Impersonates a user based on their Azure Active Directory (AAD) object id by passing that value along with the header "CallerObjectId". A String should represent a GUID value.
• Optional inChangeSet: boolean
Indicates if an operation must be included in a Change Set or not. Works in Batch Operations only. By default, it's "true", except for GET operations - they are not allowed in Change Sets.
• 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
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
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
A unique partition key value of a logical partition for non-relational custom entity data stored in NoSql tables of Azure heterogenous storage.
• Optional queryParams: string[]
Custom query parameters. Can be used to set parameter aliases for "$filter" and "$orderBy". Important! These parameters ARE NOT URI encoded!
• 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 signal: AbortSignal
The AbortSignal interface represents a signal object that allows you to communicate with a DOM request and abort it if required via an AbortController object.
• 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.