Integration | Pipeline

Pipelines Service.

Overview

URL	api/{tenantKey}/{orgKey}/integration/pipelines
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

• GET:
  • GET Pipelines (odata)
  • GET Pipeline by identifier
  • GET Pipeline by key
• POST:
  • POST Pipelines
  • POST Audit Pipeline
  • POST Mapper
  • POST Calc Hash
  • POST Sync Hash
  • POST Full Audit Pipeline
• PUT:
  • PUT Set Custom Attribute Pipeline
  • PUT Set IsActive Pipeline
  • PUT Set PipelineKey Pipeline
  • PUT Set Description Pipeline
  • PUT Set SourceService Pipeline
  • PUT Set TargetService Pipeline
  • PUT Set SourceOrganization Pipeline
  • PUT Set TargetOrganization Pipeline
  • PUT Set ScheduleTime Pipeline
  • PUT Set SourceTenant Pipeline
  • PUT Set TargetTenant Pipeline
  • PUT Set ERPApiPath Pipeline
  • PUT Set VKApiPath Pipeline
  • PUT Set SchemaEntity Pipeline
  • PUT Set Company Pipeline
  • PUT Set IntegrationConfig Pipeline
  • PUT Set StartDate AuditPipeline
  • PUT Set EndDate AuditPipeline
  • PUT Set NextDate AuditPipeline
  • PUT Set IsLastAuditPipeline AuditPipeline
  • PUT Set NSuccessRecords AuditPipeline
  • PUT Set NErrorRecords AuditPipeline
  • PUT Set ErrorMessage AuditPipeline
  • PUT Set LastAuditDate AuditPipeline
  • PUT Set SchemaEntity Mapper
  • PUT Set SchemaAttribute Mapper
  • PUT Set EntityERP Mapper
  • PUT Set EntityAttributeERP Mapper
  • PUT Set Unit Mapper
  • PUT Set Value Mapper
  • PUT Set IgnoreOnUpdate Mapper
• DELETE:
  • DELETE Audit Pipeline by identifier
  • DELETE Mapper by identifier
  • DELETE Pipeline by identifier
  • DELETE Pipeline by key

All Resources

This service uses the following resources:

• ApiPipelineAuditPipelinesResource
• ApiPipelineAuditPipelinesSyncAuditPipelinesResource
• ApiPipelineMappersResource
• ApiPipelineResource
• CalcHash
• FullAuditPipelineResource
• PipelineResource
• SyncHash
• ExtensibilityCustomAttributeValueResource

All Enumerations

This service uses the following enumerations:

• Unit

GET Operations

GET Pipelines (odata)

Returns a page of the list of all the entity records available.

The following elements are optional:

opts	(ODataQueryOptions) OData query option.

Response:

When successful, the response body contains the list of records available. See PipelineResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET Pipeline by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body contains the entity record. See PipelineResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

GET Pipeline by key

Returns the entity record that matches the specified key.

The following elements are required:

pipelineKey

(string) Pipeline Identifier.

Response:

When successful, the response body contains the entity record. See PipelineResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

POST Operations

POST Pipelines

Creates a new entity record.

The following elements are required:

pipelineResource

(ApiPipelineResource) The request body should contain the entity record that should be created. See ApiPipelineResource.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiPipelineResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

POST Audit Pipeline

Inserts a new 'Audit Pipeline' in the 'Pipeline'.

The following elements are required:

pipelineKey	(string) Pipeline Identifier.
value	(ApiPipelineAuditPipelinesResource) The ApiPipelineAuditPipelinesResource instance. See ApiPipelineAuditPipelinesResource.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

POST Mapper

Inserts a new 'Mapper' in the 'Pipeline'.

The following elements are required:

pipelineKey	(string) Pipeline Identifier.
value	(ApiPipelineMappersResource) The ApiPipelineMappersResource instance. See ApiPipelineMappersResource.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

POST Calc Hash

Custom operation 'CalcHash'.

The following elements are required:

calcHash

(CalcHash) CalcHash.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body contains a string.

Resource URL:

POST Sync Hash

Custom operation 'SyncHash'.

The following elements are required:

syncHash

(SyncHash) SyncHash.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body contains an item of type 'boolean'.

Resource URL:

POST Full Audit Pipeline

Custom operation 'FullAuditPipeline'.

The following elements are required:

fullAuditPipeline

(FullAuditPipelineResource) FullAuditPipeline.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body contains an item of type 'boolean'.

Resource URL:

PUT Operations

PUT Set Company Pipeline

Updates the value of attribute 'Company' in the specified entity record.

The following elements are required:

pipelineKey	(string) Pipeline Identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set Description Pipeline

Updates the value of attribute 'Description' in the specified entity record.

The following elements are required:

pipelineKey	(string) Pipeline Identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set EndDate AuditPipeline

Updates the value of attribute 'EndDate' in the specified entity record.

The following elements are required:

pipelineKey	(string) Pipeline Identifier.
lineId	(string) The detail identifier.
value	(DateTimeOffset) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set EntityAttributeERP Mapper

Updates the value of attribute 'EntityAttributeERP' in the specified entity record.

The following elements are required:

pipelineKey	(string) Pipeline Identifier.
lineId	(string) The detail identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set EntityERP Mapper

Updates the value of attribute 'EntityERP' in the specified entity record.

The following elements are required:

pipelineKey	(string) Pipeline Identifier.
lineId	(string) The detail identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set ERPApiPath Pipeline

Updates the value of attribute 'ERPApiPath' in the specified entity record.

The following elements are required:

pipelineKey	(string) Pipeline Identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set ErrorMessage AuditPipeline

Updates the value of attribute 'ErrorMessage' in the specified entity record.

The following elements are required:

pipelineKey	(string) Pipeline Identifier.
lineId	(string) The detail identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set IgnoreOnUpdate Mapper

Updates the value of attribute 'IgnoreOnUpdate' in the specified entity record.

The following elements are required:

pipelineKey	(string) Pipeline Identifier.
lineId	(string) The detail identifier.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set IntegrationConfig Pipeline

Updates the value of attribute 'IntegrationConfig' in the specified entity record.

The following elements are required:

pipelineKey	(string) Pipeline Identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set IsActive Pipeline

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

pipelineKey	(string) Pipeline Identifier.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

PUT Set IsLastAuditPipeline AuditPipeline

Updates the value of attribute 'IsLastAuditPipeline' in the specified entity record.

The following elements are required:

pipelineKey	(string) Pipeline Identifier.
lineId	(string) The detail identifier.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set LastAuditDate AuditPipeline

Updates the value of attribute 'LastAuditDate' in the specified entity record.

The following elements are required:

pipelineKey	(string) Pipeline Identifier.
lineId	(string) The detail identifier.
value	(DateTimeOffset) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set NErrorRecords AuditPipeline

Updates the value of attribute 'NErrorRecords' in the specified entity record.

The following elements are required:

pipelineKey	(string) Pipeline Identifier.
lineId	(string) The detail identifier.
value	(int) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set NextDate AuditPipeline

Updates the value of attribute 'NextDate' in the specified entity record.

The following elements are required:

pipelineKey	(string) Pipeline Identifier.
lineId	(string) The detail identifier.
value	(DateTimeOffset) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set NSuccessRecords AuditPipeline

Updates the value of attribute 'NSuccessRecords' in the specified entity record.

The following elements are required:

pipelineKey	(string) Pipeline Identifier.
lineId	(string) The detail identifier.
value	(int) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set PipelineKey Pipeline

Updates the value of attribute 'PipelineKey' in the specified entity record.

The following elements are required:

pipelineKey	(string) Pipeline Identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set ScheduleTime Pipeline

Updates the value of attribute 'ScheduleTime' in the specified entity record.

The following elements are required:

pipelineKey	(string) Pipeline Identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set SchemaAttribute Mapper

Updates the value of attribute 'SchemaAttribute' in the specified entity record.

The following elements are required:

pipelineKey	(string) Pipeline Identifier.
lineId	(string) The detail identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set SchemaEntity Mapper

Updates the value of attribute 'SchemaEntity' in the specified entity record.

The following elements are required:

pipelineKey	(string) Pipeline Identifier.
lineId	(string) The detail identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set SchemaEntity Pipeline

Updates the value of attribute 'SchemaEntity' in the specified entity record.

The following elements are required:

pipelineKey	(string) Pipeline Identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set SourceOrganization Pipeline

Updates the value of attribute 'SourceOrganization' in the specified entity record.

The following elements are required:

pipelineKey	(string) Pipeline Identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set SourceService Pipeline

Updates the value of attribute 'SourceService' in the specified entity record.

The following elements are required:

pipelineKey	(string) Pipeline Identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set SourceTenant Pipeline

Updates the value of attribute 'SourceTenant' in the specified entity record.

The following elements are required:

pipelineKey	(string) Pipeline Identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set StartDate AuditPipeline

Updates the value of attribute 'StartDate' in the specified entity record.

The following elements are required:

pipelineKey	(string) Pipeline Identifier.
lineId	(string) The detail identifier.
value	(DateTimeOffset) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set TargetOrganization Pipeline

Updates the value of attribute 'TargetOrganization' in the specified entity record.

The following elements are required:

pipelineKey	(string) Pipeline Identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set TargetService Pipeline

Updates the value of attribute 'TargetService' in the specified entity record.

The following elements are required:

pipelineKey	(string) Pipeline Identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set TargetTenant Pipeline

Updates the value of attribute 'TargetTenant' in the specified entity record.

The following elements are required:

pipelineKey	(string) Pipeline Identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set Unit Mapper

Updates the value of attribute 'Unit' in the specified entity record.

The following elements are required:

pipelineKey	(string) Pipeline Identifier.
lineId	(string) The detail identifier.
value	(enum Unit) The request body should contain the new value for the attribute. See Unit.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set Value Mapper

Updates the value of attribute 'Value' in the specified entity record.

The following elements are required:

pipelineKey	(string) Pipeline Identifier.
lineId	(string) The detail identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set VKApiPath Pipeline

Updates the value of attribute 'VKApiPath' in the specified entity record.

The following elements are required:

pipelineKey	(string) Pipeline Identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set Custom Attribute Pipeline

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

pipelineKey	(string) Pipeline Identifier
customAttributeName	(string) The custom attribute name.
value	(ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

DELETE Operations

DELETE Audit Pipeline by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

pipelineKey	(string) Pipeline Identifier.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

DELETE Mapper by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

pipelineKey	(string) Pipeline Identifier.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

DELETE Pipeline by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

DELETE Pipeline by key

Deletes the entity record that matches the specified key.

The following elements are required:

pipelineKey

(string) Pipeline Identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

Resources

ApiPipelineAuditPipelinesResource

The following elements are required:

startDate	(DateTimeOffset) Start Date.
endDate	(DateTimeOffset) End Date.
isLastAuditPipeline	(bool) Is Last Audit Pipeline?.
nSuccessRecords	(int) Sucess Records Number.
nErrorRecords	(int) Error Records Number.

The following elements are optional:

nextDate	(DateTimeOffset) Next Date.
errorMessage	(string) Error Message.
syncAuditPipelines	(List of ApiPipelineAuditPipelinesSyncAuditPipelinesResource) Sync Audit Pipelines. See ApiPipelineAuditPipelinesSyncAuditPipelinesResource.
lastAuditDate	(DateTimeOffset) Last Audit Date.

ApiPipelineAuditPipelinesSyncAuditPipelinesResource

The following elements are required:

syncStartDate	(DateTimeOffset) Sync Start Date.
syncStatus	(int) Sync Status Code.
sourceEntityVersionNumber	(int) Source Entity Version Number.
targetEntityVersionNumber	(int) Target Entity Version Number.

The following elements are optional:

syncEndDate	(DateTimeOffset) Sync End Date.
syncRequest	(string) Sync Request.
syncErrorMessage	(string) Sync Error Message.
sourceEntityId	(Guid) Source Entity Id.
targetEntityId	(Guid) Target Entity Id.
sourceEntityKey	(string) Source Entity Key.
targetEntityKey	(string) Target Entity Key.
sourceEntityVersion	(string) Source Entity Version.
targetEntityVersion	(string) Target Entity Version.

ApiPipelineMappersResource

The following elements are required:

schemaAttribute	(string) Attribute.
entityERP	(string) Entity ERP.
entityAttributeERP	(string) Entity Attribute ERP.
unit	(enum Unit) Unit. See Unit.

The following elements are optional:

schemaEntity	(string) Entity.
value	(string) Value.
ignoreOnUpdate	(bool) Ignore On Update.

ApiPipelineResource

The following elements are required:

pipelineKey	(string) Pipeline Identifier.
description	(string) Pipeline Description.
sourceService	(string) Source Service.
targetService	(string) Target Service.
sourceOrganization	(string) Source Organization.
targetOrganization	(string) Target Organization.
sourceTenant	(string) Source Tenant.
targetTenant	(string) Target Tenant.

The following elements are optional:

scheduleTime	(string) Schedule Time.
auditPipelines	(List of ApiPipelineAuditPipelinesResource) Audit Pipelines. See ApiPipelineAuditPipelinesResource.
mappers	(List of ApiPipelineMappersResource) Mappers. See ApiPipelineMappersResource.
eRPApiPath	(string) ERP Api Path.
vKApiPath	(string) Valuekeep Api Path.
schemaEntity	(string) Schema Entity.
company	(string) Company.
integrationConfig	(string) Integration Config.

CalcHash

The following elements are required:

baseEntity

(string) Base Entity.

The following elements are optional:

algorithm	(string) Algorithm.
lyncEntities	(string) Lync Entities.
attributes	(string) Attributes.
filter	(string) Filter.
fieldSourceHash	(string) Field Source Hash.
fieldTargetHash	(string) Field Target Hash.
fieldIsSync	(string) Field Is Sync.

FullAuditPipelineResource

The following elements are required:

pipelineKey	(string) Pipeline Identifier.
description	(string) Pipeline Description.
sourceOrganization	(string) Source Organization.
targetOrganization	(string) Target Organization.
sourceService	(string) Source Service.
targetService	(string) Target Service.
endDate	(DateTimeOffset) End Date.
sourceEntityVersionNumber	(int) Source Entity Version Number.
startDate	(DateTimeOffset) Start Date.
syncStartDate	(DateTimeOffset) Sync Start Date.
syncStatus	(int) Sync Status Code.
targetEntityVersionNumber	(int) Target Entity Version Number.
sourceTenant	(string) Source Tenant.
targetTenant	(string) Target Tenant.

The following elements are optional:

scheduleTime	(string) Schedule Time.
auditPipelines	(string) Audit Pipelines.
errorMessage	(string) Error Message.
nextDate	(DateTimeOffset) Next Date.
sourceEntityId	(Guid) Source Entity Id.
sourceEntityKey	(string) Source Entity Key.
sourceEntityVersion	(string) Source Entity Version.
syncAuditPipelines	(string) Sync Audit Pipelines.
syncEndDate	(DateTimeOffset) Sync End Date.
syncErrorMessage	(string) Sync Error Message.
syncRequest	(string) Sync Request.
targetEntityId	(Guid) Target Entity Id.
targetEntityKey	(string) Target Entity Key.
targetEntityVersion	(string) Target Entity Version.

PipelineResource

The following elements are required:

pipelineKey	(string) Pipeline Identifier.
description	(string) Pipeline Description.
sourceService	(string) Source Service.
targetService	(string) Target Service.
sourceOrganization	(string) Source Organization.
targetOrganization	(string) Target Organization.
sourceTenant	(string) Source Tenant.
targetTenant	(string) Target Tenant.

The following elements are optional:

scheduleTime	(string) Schedule Time.
auditPipelines	(List of AuditPipelineResource) Audit Pipelines. See AuditPipelineResource.
mappers	(List of MapperResource) Mappers. See MapperResource.
eRPApiPath	(string) ERP Api Path.
vKApiPath	(string) Valuekeep Api Path.
schemaEntity	(string) Schema Entity. (fk) Allowed value: the natural key of a record of type SchemaEntity. These records are accessibly through the SchemaEntities service.
company	(string) Company. (fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.
integrationConfig	(string) Integration Config. (fk) Allowed value: the natural key of a record of type IntegrationConfig. These records are accessibly through the IntegrationConfigs service.

SyncHash

The following elements are required:

baseEntity	(string) Base Entity.
valueSourceHash	(string) Value Source Hash.

The following elements are optional:

fieldSourceHash	(string) Field Source Hash.
fieldTargetHash	(string) Field Target Hash.
fieldIsSync	(string) Field Is Sync.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.

Enumerations

Unit

1	DefaultType
2	Enumerable
3	Expression
4	DefaultValue