Skip to content

v1 Class.DynamicsWebApi

Jump to bottom
Aleksandr Rogov edited this page May 12, 2025 · 2 revisions

dynamics-web-api-wiki / DynamicsWebApi

Class: DynamicsWebApi

Constructors

Constructor

new DynamicsWebApi(config?): DynamicsWebApi

DynamicsWebApi constructor

Parameters

Parameter Type Description
config? Config DynamicsWebApi configuration

Returns

DynamicsWebApi

Properties

Property Type Description
utility Utility Utility functions Deprecated please use dynamicsWebApi.Utility instead
Utility Utility Utility functions

Methods

associate()

associate(collection, primaryKey, relationshipName, relatedCollection, relatedKey, impersonateUserId?): Promise<any>

Associate for a collection-valued navigation property. (1:N or N:N)

Parameters

Parameter Type Description
collection string Primary Entity Collection name or Entity Name.
primaryKey string Primary entity record id.
relationshipName string Relationship name.
relatedCollection string Related Entity Collection name or Entity Name.
relatedKey string Related entity record id.
impersonateUserId? string A String representing the GUID value for the Dynamics 365 system user id. Impersonates the user.

Returns

Promise<any>

associateSingleValued()

associateSingleValued(collection, key, singleValuedNavigationPropertyName, relatedCollection, relatedKey, impersonateUserId?): Promise<any>

Associate for a single-valued navigation property. (1:N)

Parameters

Parameter Type Description
collection string The name of the Entity Collection or Entity Logical name.
key string Entity record Id that contains an attribute.
singleValuedNavigationPropertyName string Single-valued navigation property name (usually it's a Schema Name of the lookup attribute).
relatedCollection string Related collection name that the lookup (attribute) points to.
relatedKey string Related entity record id that needs to be associated.
impersonateUserId? string A String representing the GUID value for the Dynamics 365 system user id. Impersonates the user.

Returns

Promise<any>

count()

count(collection, filter?): Promise<number>

Sends an asynchronous request to count records. IMPORTANT! The count value does not represent the total number of entities in the system. It is limited by the maximum number of entities that can be returned. Returns: Number

Parameters

Parameter Type Description
collection string The name of the Entity Collection or Entity Logical name.
filter? string Use the $filter system query option to set criteria for which entities will be returned.

Returns

Promise<number>

countAll()

countAll(collection, filter?, select?): Promise<number>

Sends an asynchronous request to count records. Returns: Number

Parameters

Parameter Type Description
collection string The name of the Entity Collection or Entity Logical name.
filter? string Use the $filter system query option to set criteria for which entities will be returned.
select? string[] An Array representing the $select Query Option to control which attributes will be returned.

Returns

Promise<number>

create()

create<T>(object, collection, prefer?, select?): Promise<T>

Sends an asynchronous request to create a new record.

Type Parameters

Type Parameter Default type
T any

Parameters

Parameter Type Description
object T A JavaScript object valid for create operations.
collection string The name of the Entity Collection or Entity Logical name.
prefer? string | string[] Sets a Prefer header value. For example: ['retrun=representation', 'odata.include-annotations="*"'].
select? string[] An Array representing the $select Query Option to control which attributes will be returned.

Returns

Promise<T>

Deprecated

Please use "createRequest". It will be easier to fix breaking changes once v2 is realeased.

Example

var lead = {
   subject: "Test WebAPI",
   firstname: "Test",
   lastname: "WebAPI",
   jobtitle: "Title"
};

dynamicsWebApi.create(lead, "leads").then(function (id) {
}.catch(function (error) {
});

createAttribute()

createAttribute<T>(entityKey, attributeDefinition): Promise<T>

Sends an asynchronous request to create an attribute.

Type Parameters

Type Parameter Default type
T any

Parameters

Parameter Type Description
entityKey string The Entity MetadataId or Alternate Key (such as LogicalName).
attributeDefinition Object Object that describes the attribute.

Returns

Promise<T>

createEntity()

createEntity<T>(entityDefinition): Promise<T>

Sends an asynchronous request to create an entity definition.

Type Parameters

Type Parameter Default type
T any

Parameters

Parameter Type Description
entityDefinition Object Entity Definition.

Returns

Promise<T>

createGlobalOptionSet()

createGlobalOptionSet<T>(globalOptionSetDefinition): Promise<T>

Sends an asynchronous request to create a Global Option Set definition

Type Parameters

Type Parameter Default type
T any

Parameters

Parameter Type Description
globalOptionSetDefinition Object Global Option Set Definition.

Returns

Promise<T>

createRelationship()

createRelationship<T>(relationshipDefinition): Promise<T>

Sends an asynchronous request to create a relationship definition.

Type Parameters

Type Parameter Default type
T any

Parameters

Parameter Type Description
relationshipDefinition Object Relationship Definition.

Returns

Promise<T>

createRequest()

createRequest<T>(request): Promise<T>

Sends an asynchronous request to create a new record.

Type Parameters

Type Parameter Default type
T any

Parameters

Parameter Type Description
request CreateRequest<T> An object that represents all possible options for a current request.

Returns

Promise<T>

Example

var lead = {
   subject: "Test WebAPI",
   firstname: "Test",
   lastname: "WebAPI",
   jobtitle: "Title"
};

var request = {
   entity: lead,
   collection: "leads",
   returnRepresentation: true
}

dynamicsWebApi.createRequest(request).then(function (response) {
}.catch(function (error) {
});

deleteGlobalOptionSet()

deleteGlobalOptionSet(globalOptionSetKey): Promise<any>

Sends an asynchronous request to delete a Global Option Set.

Parameters

Parameter Type Description
globalOptionSetKey string A String representing the GUID value or Alternate Key (such as Name).

Returns

Promise<any>

deleteRecord()

deleteRecord(key, collection, propertyName?): Promise<any>

Sends an asynchronous request to delete a record.

Parameters

Parameter Type Description
key string A String representing the GUID value or Alternate Key(s) for the record to delete.
collection string The name of the Entity Collection or Entity Logical name.
propertyName? string The name of the property which needs to be emptied. Instead of removing a whole record only the specified property will be cleared.

Returns

Promise<any>

Deprecated

Please use "deleteRequest". It will be easier to fix breaking changes once v2 is realeased.

deleteRelationship()

deleteRelationship(metadataId): Promise<any>

Sends an asynchronous request to delete a relationship definition.

Parameters

Parameter Type Description
metadataId string A String representing the GUID value.

Returns

Promise<any>

deleteRequest()

deleteRequest(request): Promise<any>

Sends an asynchronous request to delete a record.

Parameters

Parameter Type Description
request DeleteRequest An object that represents all possible options for a current request.

Returns

Promise<any>

disassociate()

disassociate(collection, primaryKey, relationshipName, relatedKey, impersonateUserId?): Promise<any>

Disassociate for a collection-valued navigation property.

Parameters

Parameter Type Description
collection string Primary Entity Collection name or Entity Name.
primaryKey string Primary entity record id.
relationshipName string Relationship name.
relatedKey string Related entity record id.
impersonateUserId? string A String representing the GUID value for the Dynamics 365 system user id. Impersonates the user.

Returns

Promise<any>

disassociateSingleValued()

disassociateSingleValued(collection, key, singleValuedNavigationPropertyName, impersonateUserId?): Promise<any>

Removes a reference to an entity for a single-valued navigation property. (1:N)

Parameters

Parameter Type Description
collection string The name of the Entity Collection or Entity Logical name.
key string Entity record Id that contains an attribute.
singleValuedNavigationPropertyName string Single-valued navigation property name (usually it's a Schema Name of the lookup attribute).
impersonateUserId? string A String representing the GUID value for the Dynamics 365 system user id. Impersonates the user.

Returns

Promise<any>

downloadFile()

downloadFile(request): Promise<DownloadResponse>

Downloads a file from a file attribute

Parameters

Parameter Type Description
request DownloadRequest An object that represents all possible options for a current request.

Returns

Promise<DownloadResponse>

executeBatch()

executeBatch(request?): Promise<any[]>

Executes a batch request. Please call DynamicsWebApi.startBatch() first to start a batch request.

Parameters

Parameter Type
request? BatchRequest

Returns

Promise<any[]>

executeBoundAction()

executeBoundAction<T>(id, collection, actionName, requestObject?, impersonateUserId?): Promise<T>

Executes a bound Web API action (bound to a particular entity record)

Type Parameters

Type Parameter Default type
T any

Parameters

Parameter Type Description
id string A String representing the GUID value for the record (pass "null" for an optional parameter)
collection string The name of the Entity Collection or Entity Logical name.
actionName string The name of the Web API action.
requestObject? Object Action request body object.
impersonateUserId? string A String representing the GUID value for the Dynamics 365 system user id. Impersonates the user.

Returns

Promise<T>

executeBoundFunction()

executeBoundFunction<T>(id, collection, functionName, parameters?, impersonateUserId?): Promise<T>

Executes a bound function

Type Parameters

Type Parameter Default type
T any

Parameters

Parameter Type Description
id string A String representing the GUID value for the record.
collection string The name of the Entity Collection or Entity Logical name.
functionName string The name of the function.
parameters? Object Function's input parameters. Example: { param1: "test", param2: 3 }.
impersonateUserId? string A String representing the GUID value for the Dynamics 365 system user id. Impersonates the user.

Returns

Promise<T>

executeFetchXml()

executeFetchXml<T>(collection, fetchXml, includeAnnotations?, pageNumber?, pagingCookie?, impersonateUserId?): Promise<FetchXmlResponse<T>>

Sends an asynchronous request to count records. Returns: DWA.Types.FetchXmlResponse

Type Parameters

Type Parameter Default type
T any

Parameters

Parameter Type Description
collection string The name of the Entity Collection or Entity Logical name.
fetchXml string FetchXML is a proprietary query language that provides capabilities to perform aggregation.
includeAnnotations? string Use this parameter to include annotations to a result. For example: * or Microsoft.Dynamics.CRM.fetchxmlpagingcookie
pageNumber? number Page number.
pagingCookie? string Paging cookie. For retrieving the first page, pagingCookie should be null.
impersonateUserId? string A String representing the GUID value for the Dynamics 365 system user id. Impersonates the user.

Returns

Promise<FetchXmlResponse<T>>

executeFetchXmlAll()

executeFetchXmlAll<T>(collection, fetchXml, includeAnnotations?, impersonateUserId?): Promise<MultipleResponse<T>>

Sends an asynchronous request to execute FetchXml to retrieve all records.

Type Parameters

Type Parameter Default type
T any

Parameters

Parameter Type Description
collection string The name of the Entity Collection or Entity Logical name.
fetchXml string FetchXML is a proprietary query language that provides capabilities to perform aggregation.
includeAnnotations? string Use this parameter to include annotations to a result. For example: * or Microsoft.Dynamics.CRM.fetchxmlpagingcookie
impersonateUserId? string A String representing the GUID value for the Dynamics 365 system user id. Impersonates the user.

Returns

Promise<MultipleResponse<T>>

executeUnboundAction()

executeUnboundAction<T>(actionName, requestObject?, impersonateUserId?): Promise<T>

Executes an unbound Web API action (not bound to a particular entity record)

Type Parameters

Type Parameter Default type
T any

Parameters

Parameter Type Description
actionName string The name of the Web API action.
requestObject? Object Action request body object.
impersonateUserId? string A String representing the GUID value for the Dynamics 365 system user id. Impersonates the user.

Returns

Promise<T>

executeUnboundFunction()

executeUnboundFunction<T>(functionName, parameters?, impersonateUserId?): Promise<T>

Executes an unbound function (not bound to a particular entity record)

Type Parameters

Type Parameter Default type
T any

Parameters

Parameter Type Description
functionName string The name of the function.
parameters? Object Function's input parameters. Example: { param1: "test", param2: 3 }.
impersonateUserId? string A String representing the GUID value for the Dynamics 365 system user id. Impersonates the user.

Returns

Promise<T>

fetch()

fetch<T>(collection, fetchXml, includeAnnotations?, pageNumber?, pagingCookie?, impersonateUserId?): Promise<FetchXmlResponse<T>>

Sends an asynchronous request to count records. Returns: DWA.Types.FetchXmlResponse

Type Parameters

Type Parameter Default type
T any

Parameters

Parameter Type Description
collection string The name of the Entity Collection or Entity Logical name.
fetchXml string FetchXML is a proprietary query language that provides capabilities to perform aggregation.
includeAnnotations? string Use this parameter to include annotations to a result. For example: * or Microsoft.Dynamics.CRM.fetchxmlpagingcookie
pageNumber? number Page number.
pagingCookie? string Paging cookie. For retrieving the first page, pagingCookie should be null.
impersonateUserId? string A String representing the GUID value for the Dynamics 365 system user id. Impersonates the user.

Returns

Promise<FetchXmlResponse<T>>

fetchAll()

fetchAll<T>(collection, fetchXml, includeAnnotations?, impersonateUserId?): Promise<MultipleResponse<T>>

Sends an asynchronous request to execute FetchXml to retrieve all records.

Type Parameters

Type Parameter Default type
T any

Parameters

Parameter Type Description
collection string The name of the Entity Collection or Entity Logical name.
fetchXml string FetchXML is a proprietary query language that provides capabilities to perform aggregation.
includeAnnotations? string Use this parameter to include annotations to a result. For example: * or Microsoft.Dynamics.CRM.fetchxmlpagingcookie
impersonateUserId? string A String representing the GUID value for the Dynamics 365 system user id. Impersonates the user.

Returns

Promise<MultipleResponse<T>>

initializeInstance()

initializeInstance(config?): DynamicsWebApi

Creates a new instance of DynamicsWebApi

Parameters

Parameter Type Description
config? Config configuration object.

Returns

DynamicsWebApi

retrieve()

retrieve<T>(key, collection, select?, expand?): Promise<T>

Sends an asynchronous request to retrieve a record.

Type Parameters

Type Parameter Default type
T any

Parameters

Parameter Type Description
key string A String representing the GUID value or Alternate Key(s) for the record to retrieve.
collection string The name of the Entity Collection or Entity Logical name.
select? string[] An Array representing the $select Query Option to control which attributes will be returned.
expand? Expand[] A String or Array of Expand Objects representing the $expand Query Option value to control which related records need to be returned.

Returns

Promise<T>

Deprecated

Please use "retrieveRequest". It will be easier to fix breaking changes once v2 is realeased.

retrieveAll()

retrieveAll<T>(collection, select?, filter?): Promise<AllResponse<T>>

Sends an asynchronous request to retrieve all records.

Type Parameters

Type Parameter Default type
T any

Parameters

Parameter Type Description
collection string The name of the Entity Collection or Entity Logical name.
select? string[] Use the $select system query option to limit the properties returned.
filter? string Use the $filter system query option to set criteria for which entities will be returned.

Returns

Promise<AllResponse<T>>

Deprecated

Please use "retrieveAllRequest". It will be easier to fix breaking changes once v2 is realeased.

retrieveAllRequest()

retrieveAllRequest<T>(request): Promise<AllResponse<T>>

Sends an asynchronous request to retrieve all records.

Type Parameters

Type Parameter Default type
T any

Parameters

Parameter Type Description
request RetrieveMultipleRequest An object that represents all possible options for a current request.

Returns

Promise<AllResponse<T>>

retrieveAttribute()

retrieveAttribute<T>(entityKey, attributeKey, attributeType?, select?, expand?): Promise<T>

Sends an asynchronous request to retrieve a specific attribute metadata for a specified entity definition.

Type Parameters

Type Parameter Default type
T any

Parameters

Parameter Type Description
entityKey string The Entity MetadataId or Alternate Key (such as LogicalName).
attributeKey string The Attribute Metadata id.
attributeType? string Use this parameter to cast the Attribute to a specific type.
select? string[] Use the $select system query option to limit the properties returned.
expand? Expand[] A String or Array of Expand Objects representing the $expand Query Option value to control which related records need to be returned.

Returns

Promise<T>

retrieveAttributes()

retrieveAttributes<T>(entityKey, attributeType?, select?, filter?, expand?): Promise<RetrieveMultipleResponse<T>>

Sends an asynchronous request to retrieve attribute metadata for a specified entity definition.

Type Parameters

Type Parameter Default type
T any

Parameters

Parameter Type Description
entityKey string The Entity MetadataId or Alternate Key (such as LogicalName).
attributeType? string Use this parameter to cast the Attributes to a specific type.
select? string[] Use the $select system query option to limit the properties returned.
filter? string Use the $filter system query option to set criteria for which attribute definitions will be returned.
expand? Expand[] A String or Array of Expand Objects representing the $expand Query Option value to control which related records need to be returned.

Returns

Promise<RetrieveMultipleResponse<T>>

retrieveEntities()

retrieveEntities<T>(select?, filter?): Promise<RetrieveMultipleResponse<T>>

Sends an asynchronous request to retrieve entity definitions.

Type Parameters

Type Parameter Default type
T any

Parameters

Parameter Type Description
select? string[] Use the $select system query option to limit the properties returned.
filter? string Use the $filter system query option to set criteria for which entity definitions will be returned.

Returns

Promise<RetrieveMultipleResponse<T>>

retrieveEntity()

retrieveEntity<T>(entityKey, select?, expand?): Promise<T>

Sends an asynchronous request to retrieve a specific entity definition.

Type Parameters

Type Parameter Default type
T any

Parameters

Parameter Type Description
entityKey string The Entity MetadataId or Alternate Key (such as LogicalName).
select? string[] Use the $select system query option to limit the properties returned.
expand? Expand[] A String or Array of Expand Objects representing the $expand Query Option value to control which related records need to be returned.

Returns

Promise<T>

retrieveGlobalOptionSet()

retrieveGlobalOptionSet<T>(globalOptionSetKey, castType?, select?): Promise<T>

Sends an asynchronous request to retrieve Global Option Set definitions.

Type Parameters

Type Parameter Default type
T any

Parameters

Parameter Type Description
globalOptionSetKey string The Global Option Set MetadataID or Alternate Key (such as Name).
castType? string Use this parameter to cast a Global Option Set to a specific type.
select? string[] Use the $select system query option to limit the properties returned

Returns

Promise<T>

retrieveGlobalOptionSets()

retrieveGlobalOptionSets<T>(castType?, select?): Promise<RetrieveMultipleResponse<T>>

Sends an asynchronous request to retrieve Global Option Set definitions.

Type Parameters

Type Parameter Default type
T any

Parameters

Parameter Type Description
castType? string Use this parameter to cast a Global Option Set to a specific type.
select? string[] Use the $select system query option to limit the properties returned

Returns

Promise<RetrieveMultipleResponse<T>>

retrieveMultiple()

retrieveMultiple<T>(collection, select?, filter?, oDataLink?): Promise<RetrieveMultipleResponse<T>>

Sends an asynchronous request to retrieve records.

Type Parameters

Type Parameter Default type
T any

Parameters

Parameter Type Description
collection string The name of the Entity Collection or Entity Logical name.
select? string[] Use the $select system query option to limit the properties returned.
filter? string Use the $filter system query option to set criteria for which entities will be returned.
oDataLink? string Use this parameter to pass @odata.nextLink or @odata.deltaLink to return a necessary response. Pass null to retrieveMultipleOptions.

Returns

Promise<RetrieveMultipleResponse<T>>

Deprecated

Please use "retrieveMultipleRequest". It will be easier to fix breaking changes once v2 is realeased.

retrieveMultipleRequest()

retrieveMultipleRequest<T>(request, oDataLink?): Promise<RetrieveMultipleResponse<T>>

Sends an asynchronous request to retrieve records.

Type Parameters

Type Parameter Default type
T any

Parameters

Parameter Type Description
request RetrieveMultipleRequest An object that represents all possible options for a current request.
oDataLink? string Use this parameter to pass @odata.nextLink or @odata.deltaLink to return a necessary response. Pass null to retrieveMultipleOptions

Returns

Promise<RetrieveMultipleResponse<T>>

retrieveRelationship()

retrieveRelationship<T>(metadataId, relationshipType?, select?): Promise<T>

Sends an asynchronous request to retrieve a specific relationship definition.

Type Parameters

Type Parameter Default type
T any

Parameters

Parameter Type Description
metadataId string String representing the Metadata Id GUID.
relationshipType? string Use this parameter to cast a Relationship to a specific type: 1:M or M:M.
select? string[] Use the $select system query option to limit the properties returned.

Returns

Promise<T>

retrieveRelationships()

retrieveRelationships<T>(relationshipType?, select?, filter?): Promise<RetrieveMultipleResponse<T>>

Sends an asynchronous request to retrieve relationship definitions.

Type Parameters

Type Parameter Default type
T any

Parameters

Parameter Type Description
relationshipType? string Use this parameter to cast a Relationship to a specific type: 1:M or M:M.
select? string[] Use the $select system query option to limit the properties returned.
filter? string Use the $filter system query option to set criteria for which relationships will be returned.

Returns

Promise<RetrieveMultipleResponse<T>>

retrieveRequest()

retrieveRequest<T>(request): Promise<T>

Sends an asynchronous request to retrieve a record.

Type Parameters

Type Parameter Default type
T any

Parameters

Parameter Type Description
request RetrieveRequest An object that represents all possible options for a current request.

Returns

Promise<T>

setConfig()

setConfig(config): void

Sets DynamicsWebApi configuration parameters.

Parameters

Parameter Type Description
config Config configuration object

Returns

void

Example

dynamicsWebApi.setConfig({ webApiVersion: '9.1' });

startBatch()

startBatch(): void

Starts a batch request.

Returns

void

update()

update<T>(key, collection, object, prefer?, select?): Promise<T>

Sends an asynchronous request to update a record.

Type Parameters

Type Parameter Default type
T any

Parameters

Parameter Type Description
key string A String representing the GUID value or Alternate Key(s) for the record to update.
collection string The name of the Entity Collection or Entity Logical name.
object T A JavaScript object valid for update operations.
prefer? string | string[] If set to "return=representation" the function will return an updated object
select? string[] An Array representing the $select Query Option to control which attributes will be returned.

Returns

Promise<T>

Deprecated

Please use "updateRequest". It will be easier to fix breaking changes once v2 is realeased.

updateAttribute()

updateAttribute<T>(entityKey, attributeDefinition, attributeType?, mergeLabels?): Promise<T>

Sends an asynchronous request to update an attribute.

Type Parameters

Type Parameter Default type
T any

Parameters

Parameter Type Description
entityKey string The Entity MetadataId or Alternate Key (such as LogicalName).
attributeDefinition Object Object that describes the attribute.
attributeType? string Use this parameter to cast the Attribute to a specific type.
mergeLabels? boolean Sets MSCRM.MergeLabels header that controls whether to overwrite the existing labels or merge your new label with any existing language labels. Default value is false.

Returns

Promise<T>

updateEntity()

updateEntity<T>(entityDefinition, mergeLabels?): Promise<T>

Sends an asynchronous request to update an entity definition.

Type Parameters

Type Parameter Default type
T any

Parameters

Parameter Type Description
entityDefinition Object Entity Definition.
mergeLabels? boolean Sets MSCRM.MergeLabels header that controls whether to overwrite the existing labels or merge your new label with any existing language labels. Default value is false.

Returns

Promise<T>

updateGlobalOptionSet()

updateGlobalOptionSet<T>(globalOptionSetDefinition, mergeLabels?): Promise<T>

Sends an asynchronous request to update a Global Option Set.

Type Parameters

Type Parameter Default type
T any

Parameters

Parameter Type Description
globalOptionSetDefinition Object Global Option Set Definition.
mergeLabels? boolean Sets MSCRM.MergeLabels header that controls whether to overwrite the existing labels or merge your new label with any existing language labels. Default value is false.

Returns

Promise<T>

updateRelationship()

updateRelationship<T>(relationshipDefinition, relationshipType?, mergeLabels?): Promise<T>

Sends an asynchronous request to update a relationship definition.

Type Parameters

Type Parameter Default type
T any

Parameters

Parameter Type Description
relationshipDefinition Object Relationship Definition.
relationshipType? string Use this parameter to cast the Relationship to a specific type.
mergeLabels? boolean Sets MSCRM.MergeLabels header that controls whether to overwrite the existing labels or merge your new label with any existing language labels. Default value is false.

Returns

Promise<T>

updateRequest()

updateRequest<T>(request): Promise<T>

Sends an asynchronous request to update a record.

Type Parameters

Type Parameter Default type
T any

Parameters

Parameter Type Description
request UpdateRequest<T> An object that represents all possible options for a current request.

Returns

Promise<T>

updateSingleProperty()

updateSingleProperty<T>(key, collection, keyValuePair, prefer?, select?): Promise<T>

Sends an asynchronous request to update a single value in the record.

Type Parameters

Type Parameter Default type
T any

Parameters

Parameter Type Description
key string A String representing the GUID value or Alternate Key(s) for the record to update.
collection string The name of the Entity Collection or Entity Logical name.
keyValuePair {[key: string]: any; } keyValuePair object with a logical name of the field as a key and a value to update with. Example: {subject: "Update Record"}
prefer? string | string[] If set to "return=representation" the function will return an updated object
select? string[] An Array representing the $select Query Option to control which attributes will be returned.

Returns

Promise<T>

uploadFile()

uploadFile(request): Promise<void>

Uploads a file to a file attribute

Parameters

Parameter Type Description
request UploadRequest An object that represents all possible options for a current request.

Returns

Promise<void>

upsert()

upsert<T>(key, collection, object, prefer?, select?): Promise<T>

Sends an asynchronous request to upsert a record.

Type Parameters

Type Parameter Default type
T any

Parameters

Parameter Type Description
key string A String representing the GUID value or Alternate Key(s) for the record to upsert.
collection string The name of the Entity Collection or Entity Logical name.
object T A JavaScript object valid for update operations.
prefer? string | string[] If set to "return=representation" the function will return an updated object
select? string[] An Array representing the $select Query Option to control which attributes will be returned.

Returns

Promise<T>

Deprecated

Please use "upsertRequest". It will be easier to fix breaking changes once v2 is realeased.

upsertRequest()

upsertRequest<T>(request): Promise<T>

Sends an asynchronous request to upsert a record.

Type Parameters

Type Parameter Default type
T any

Parameters

Parameter Type Description
request UpsertRequest<T> An object that represents all possible options for a current request.

Returns

Promise<T>

API

Namespaces

Classes

Clone this wiki locally