Settings | Pipeline Sync
Service to manage entities of type 'PipelineSync'.
Overview
| URL | api/{tenantKey}/{orgKey}/settings/pipelineSyncs |
| Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
- PUT:
- DELETE:
All Resources
This service uses the following resources:
GET PipelineSyncs (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 PipelineSyncResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET PipelineSync 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 PipelineSyncResource. |
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 PipelineSync by key
Returns the entity record that matches the specified key.
The following elements are required:
| pipelineKey | (string) Pipeline. |
Response:
| When successful, the response body contains the entity record. See PipelineSyncResource. |
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 PipelineSyncs
Creates a new entity record.
The following elements are required:
| pipelineSyncResource | (ApiPipelineSyncResource) The request body should contain the entity record that should be created. See ApiPipelineSyncResource. |
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 ApiPipelineSyncResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Description PipelineSync
Updates the value of attribute 'Description' in the specified entity record.
The following elements are required:
| pipelineKey | (string) Pipeline. |
| 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 Entity PipelineSync
Updates the value of attribute 'Entity' in the specified entity record.
The following elements are required:
| pipelineKey | (string) Pipeline. |
| 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 PipelineSync
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| pipelineKey | (string) Pipeline. |
| 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 LastSyncDate PipelineSync
Updates the value of attribute 'LastSyncDate' in the specified entity record.
The following elements are required:
| pipelineKey | (string) Pipeline. |
| 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 Map PipelineSync
Updates the value of attribute 'Map' in the specified entity record.
The following elements are required:
| pipelineKey | (string) Pipeline. |
| 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 PipelineKey PipelineSync
Updates the value of attribute 'PipelineKey' in the specified entity record.
The following elements are required:
| pipelineKey | (string) Pipeline. |
| 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 SourceEndpoint PipelineSync
Updates the value of attribute 'SourceEndpoint' in the specified entity record.
The following elements are required:
| pipelineKey | (string) Pipeline. |
| 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 TargetEndpoint PipelineSync
Updates the value of attribute 'TargetEndpoint' in the specified entity record.
The following elements are required:
| pipelineKey | (string) Pipeline. |
| 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:
DELETE PipelineSync 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 PipelineSync by key
Deletes the entity record that matches the specified key.
The following elements are required:
| pipelineKey | (string) Pipeline. |
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
ApiPipelineSyncResource
The following elements are required:
| pipelineKey | (string) Pipeline. |
The following elements are optional:
| description | (string) Description. |
| sourceEndpoint | (string) Source Endpoint. |
| targetEndpoint | (string) Target Endpoint. |
| lastSyncDate | (DateTimeOffset) Last Sync Date. |
| entity | (string) Entity. |
| map | (string) Map. |
PipelineSyncResource
The following elements are required:
| pipelineKey | (string) Pipeline. |
The following elements are optional:
| description | (string) Description. |
| sourceEndpoint | (string) Source Endpoint. |
| targetEndpoint | (string) Target Endpoint. |
| lastSyncDate | (DateTimeOffset) Last Sync Date. |
| entity | (string) Entity. |
| map | (string) Map. |