MyRapidi
MyRapidi

Search our Wiki

REST API Transfers Create Transfer

In the example below we create a new Transfer with a code and description.

The created transfer will by default have a ?Implementing? status.

Examples are provided in JSON and JSONAPI format.

NOTE: Remember to substitute the token ([API SECURITY TOKEN]) and the service id ([SERVICE ID]) to your own token and service id.

JSON:

Create a new transfer for service [SERVICE ID], with code "NEW_TRANSFER_CODE" and description "A new transfer".

curl -H "Authorization: Bearer [API SECURITY TOKEN]"
  -H "Content-Type: application/json"
  -H "Accept: application/json"
  -X POST
  -d "{\"code\":\"NEW_TRANSFER_CODE\",\"description\":\"A new transfer\"} }}"
  http://staging.myrapidi.com/api/v2/service/[SERVICE ID]/transfers

The output for this example would be:

{
  "id": 1,
  "code": "NEW_TRANSFER_CODE",
  "description": "A new transfer",
  "status": "Implementing",
  "group": null,
  "source": null,
  "source_layout": null,
  "destination": null,
  "destination_layout": null,
  "source_table": null,
  "destination_table": null,
  "link_storage": null,
  "enabled": null,
  "update": null,
  "add": null,
  "delete": null,
  "actions": null,
  "move": null,
  "delete_all": null,
  "autogenerate_key": null,
  "disable_dest_lookup": null,
  "all_fields": false,
  "continue_on_error": null,
  "comments": []
}