How to customize the pipeline tags for the request URL?

How to customize the pipeline tags for the request URL?

In Valuekeep, there are "POST" requests, which come from keys, as shown below:

The method used to create a follow-up report in a work order is:

POST {{url}}/api/{{tenant}}/{{organization}}//maintenance/workOrders/{Company}}/{WorkOrderKey}}/WorkOrderNotes

To implement a pipeline with the structure specified above, you must use:

i.Prefix: "@from_";

ii.Tag: "ToEntityKeys";

iii.Number: number of the key you wish to place on the URL, otherwise, the "default = 1" is used;

iv.Suffix: "@" ;

1.      ...

2.      ToApiPath                 = Maintenance/WorkOrders;   

3.      ToApiPathPost          = Maintenance/WorkOrders/999/@from_toentitykeys1@/workordernotes; 

4.      ToCompanyDependent  = true;

5.      ToExclusiveInsert      = true;

6.      ToEntityKeys             = Key,WorkOrderKey;

7.      ToCompany               = 999;

8.      ...

In the example above one can verify the use of the API by constructing the following request: https://cloud.valuekeep.com/api/maintenance/workorders/999/{Key}/workordernotes;

 


{Key} - The record content that has been mapped in the Mapping file will be presented.

 

In case you want to use the key 2, you should use the following:

 

1.       

1.     ...

2.     ToApiPath                 = Maintenance/WorkOrders;   

3.     ToApiPathPost          = Maintenance/WorkOrders/999/@from_toentitykeys2@/workordernotes; 

4.     ToCompanyDependent  = true;

5.     ToExclusiveInsert      = true;

6.     ToEntityKeys             = Key,WorkOrderKey;

7.     ToCompany               = 999;

8.     ...

In the example above one can verify the use of the API by constructing the following request: https://cloud.valuekeep.com/api/maintenance/workorders/999/{WorkOrderKey}/workordernotes;

 


{WorkOrderKey} - The record content that has been mapped in the Mapping file will be presented.

The keys can also be used simultaneously.


    • Related Articles

    • WebAPI - Creating a request

      This method allows to create a request in a simplified manner. The method to be used when creating a request: POST url/api/mytenant/myorganization/Requests/requests Json example for creating a request: { "requestKey": "00001", "description": "Vidro ...

    • How to set up the pipeline execution (Windows Service)?

      The host is the process runtime than instantiates the Valuekeep Integrator engine (PipelineEngine) to manage the pipeline execution (using a scheduling procedure or using a specific on-demand context). The platform provides a Windows Service ...

    • WebApi - Auditing Pipeline

      The Valuekeep Integrator conceptually allows to monitor the execution of all pipelines. This feature allows the implementing agent/integrator to control the execution of integration flows and identify irregular situations that require to eventually ...

    • WebApi - Pipeline Hashing Synchronization

      Valuekeep Integrator adopts a version control based on a hashing system. Each pipeline has a version control, that is, it has a hashing key that allows to identify if the information subset (hashset) has still not been integrated or if it  suffered ...

    • WebAPI - Deleting the request

      This method allows you to delete a request. The method to be used when deleting a request: DELETE  url/api/mytenant/myorganization/requests/requests/{{companyKey}}/{{RequestKey}} The parameters being replaced on the method are: companyKey: company ...