MyRapidi
MyRapidi

Search our Wiki

REST API Transfers Get One Transfer

Below you can see an example of how to get a single transfer by id.

Examples in JSON are provided.

NOTE: Remember to substitute the token (after Bearer) and the service id (the [SERVICE ID] below) to your own token and service id.

NOTE: The JSONAPI format is currently not supported for the "Get Transfers" command.

Use Cases:

JSON

Retrieve transfer with id 114 belonging to service with id: [SERVICE ID]

curl -H "Authorization: Bearer [API SECURITY TOKEN]"
  -H "Content-Type: application/json"
  -H "Accept: application/json"
  -X GET
  https://api.myrapidi.com/api/v2/service/[SERVICE ID]/transfers/114

The output for this example would be:

[
  {
    "id": 114,
    "code": "A0_TEST_BUILDFIELDLILL",
    "description": "Testing Build Fieldlist with 677",
    "transfer_type": "Transfer",
    "status": "Implementing",
    "group": "",
    "source": "",
    "source_layout": "SFORCE001",
    "destination": "",
    "destination_layout": "",
    "source_table": "Account",
    "destination_table": "Account",
    "link_storage": "",
    "enabled": false,
    "update": true,
    "add": true,
    "delete": true,
    "actions": true,
    "move": true,
    "delete_all": true,
    "autogenerate_key": true,
    "disable_dest_lookup": true,
    "all_fields": true,
    "continue_on_error": true,
    "source_control": {
      "source_control_field": "CreatedById",
      "transferred_field": "BillingState",
      "store_new_id_field": "SicDesc",
      "destination_control_field": "",
      "commit_per": 50,
      "source_mirror": "AX011",
      "comments": [
        {
          "created_at": "2022-06-18T19:01:09Z",
          "created_by": "user_22",
          "comment": "<p>source control comment</p>"
        }
      ]
    },
    "table_link": {
      "list": [{
        "source_field": "TableLinkSource",
        "destination_field": "TableLinkDestination",
        "disabled": false
        } 
      ],
      "comments": null
    },
    "field_list": {
      "list": [
        {
          "source_field": "Id",
          "destination_field": "Identifier",
          "disabled": true
        },
        {
          "source_field": "Description",
          "destination_field": "Description",
          "disabled": false
        }
      ],
      "comments": null
    },
    "filters_source": {
      "list": [
        {
          "field_name": "Blå 2244",
          "filter": "224455",
          "disabled": true
        },
        {
          "field_name": "BillingCountryCode",
          "filter": "=222",
          "disabled": false
        }
      ],
      "comments": null
    },
    "filters_destination": {
      "list": [
        {
          "field_name": "name",
          "filter": "name = 'hugo'",
          "disabled": false
        }
      ],
      "comments": null
    },
    "default_values": {
      "list": [
        {
          "field_name": "hello",
          "value": "there",
          "disabled": false
        },
        {
          "field_name": "",
          "value": null,
          "disabled": false
        }
      ],
      "comments": null
    },
    "conversions": {
      "list": [
        {
          "field_name": "jhgjjhg fie",
          "from_value": "from me22",
          "to_value": "to me44",
          "disabled": false
        }
      ],
      "comments": null
    },
    "scatters": [
      {
        "code": "A0_TEST_BUILDFIELDLILL_ABC123",
        "description": "change me",
        "destination_table": "Hugo",
        "enabled": false,
        "update": true,
        "add": true,
        "delete": false,
        "actions": false,
        "move": false,
        "delete_all": false,
        "autogenerate_key": false,
        "disable_dest_lookup": false,
        "all_fields": true,
        "continue_on_error": null,
        "table_link": {
          "list": [
            {
              "source_field": "BillingPostalCode",
              "destination_field": "rfe",
              "disabled": false
            }
          ],
          "comments": null
        },
        "field_list": {
          "list": [
            {
              "source_field": "New_Account_Number__c",
              "destination_field": "def",
              "disabled": false
            }
          ],
          "comments": null
        },
      "filters_destination": {
        "list": [
          {
            "field_name": "ge",
            "filter": "eg",
            "disabled": false
          }
        ],
        "comments": null
      },
      "link_filters_destination": {
        "list": [
          {
            "field_name": "dee",
            "main_field_name": "dee",
            "disabled": false
          }
        ],
        "comments": null
      },
      "default_values": {
        "list": [
          {
            "field_name": "jhgfd",
            "value": "jhgf",
            "disabled": false
          }
        ],
        "comments": null
      },
      "sorting_destination_table": {
        "list": [
          {
            "field_name": "destinationTabSort",
            "disabled": false
          }
        ],
        "comments": null
      },
      "special_setup": {
        "source_view_name": "hed",
        "destination_view_name": "sed",
        "comments": []
      },
      "comments": []
      }  
    ],
    "gathers": [
      {
        "code": "A0_TEST_BUILDFIELDLILL_GATHER002",
        "description": "change me",
        "source_table": "Account",
        "enabled": false,
        "update": false,
        "add": false,
        "delete": false,
        "actions": false,
        "move": false,
        "delete_all": false,
        "autogenerate_key": false,
        "disable_dest_lookup": false,
        "all_fields": false,
        "continue_on_error": null,
        "table_link": {
          "list": [
            {
              "source_field": "lkjhgfdxs",
              "destination_field": "kjhg",
              "disabled": false
            }
          ],
          "comments": null
        },
        "field_list": {
          "list": [
            {
              "source_field": "lkjhrtttyk",
              "destination_field": "jhgfdsghfg",
              "disabled": false
            }
          ],
          "comments": null
        },
        "filters_source": {
          "list": [
            {
              "field_name": "kjh",
              "filter": "et",
              "disabled": false
            }
          ],
          "comments": null
        },
        "link_filters_source": {
          "list": [
            {
            "field_name": "deededddd",
            "main_field_name": "ddddddd",
            "disabled": false
            }
          ],
          "comments": null
        },
        "conversions": {
          "list": [
            {
              "field_name": "conversion_field",
              "from_value": "aa",
              "to_value": "bb",
              "disabled": false
            }
          ],
          "comments": null
        },
        "sorting_source_table": {
          "list": [
            {
              "field_name": "sorting_field",
              "disabled": false
            }
          ],
          "comments": null
        },
        "special_setup": {
          "source_view_name": "view_name",
          "destination_view_name": "dest_view_name",
          "comments": []
        },
        "comments": []
      } 
    ],
    "subtransfers": [
      {
        "code": "A0_TEST_BUILDFIELDLILL_SUBTR001",
        "description": "change me",
        "source_table": "Account",
        "destination_table": "Hugo",
        "enabled": false,
        "update": false,
        "add": false,
        "delete": false,
        "actions": null,
        "move": false,
        "delete_all": false,
        "autogenerate_key": false,
        "disable_dest_lookup": false,
        "all_fields": false,
        "continue_on_error": null,
        "table_link": {
          "list": [
            {
              "source_field": "ghgfrdefghfngjh",
              "destination_field": ",ghngfbfdvdsefgnh,j",
              "disabled": false
            }
          ],
          "comments": null
        },
        "field_list": {
          "list": [
            {
              "source_field": "name",
              "destination_field": "",
              "disabled": false
            }
          ],
          "comments": null
        },
        "filters_source": {
          "list": [
            {
              "field_name": "!m:l;kjhgrefredz",
              "filter": "vdsc",
              "disabled": false
            }
          ],
          "comments": null
        },
        "link_filters_source": {
          "list": [
            {
              "field_name": "!kjh,gnfbds",
              "main_field_name": "ssfgnhtegrgsthdv",
              "disabled": false
            }
          ],
          "comments": null
        },
        "filters_destination": {
          "list": [
            {
              "field_name": "sdfghn,;",
              "filter": "dfgh",
              "disabled": false
            }
          ],
          "comments": null
        },
        "link_filters_destination": {
          "list": [
            {
              "field_name": "dfsgdhfgjh",
              "main_field_name": "grh",
              "disabled": false
            }
          ],
          "comments": null
        },
        "default_values": {
          "list": [
            {
              "field_name": "fdghgfdgshg,fdf",
              "value": "fgfhdeghf,gfdf",
              "disabled": false
            }
          ],
          "comments": null
        },
        "conversions": {
          "list": [
            {
              "field_name": "abc",
              "from_value": "123",
              "to_value": "456",
              "disabled": false
            }
          ],
          "comments": null
        },
        "scatters": [
          {
            "code": "A0_TEST_BUILDFIELDLILL_SUBTR001_SCATTER001",
            "description": "change me",
            "destination_table": "",
            "enabled": false,
            "update": false,
            "add": false,
            "delete": false,
            "actions": false,
            "move": false,
            "delete_all": false,
            "autogenerate_key": false,
            "disable_dest_lookup": false,
            "all_fields": false,
            "continue_on_error": null,
            "field_list": {
              "list": [
                {
                  "source_field": "na",
                  "destination_field": "",
                  "disabled": false
                }
              ],
              "comments": null
            },
            "comments": []
          }
        ],
        "subtransfers": [
          {
            "code": "A0_TEST_BUILDFIELDLILL_SUBTR001_SUBTR001",
            "description": "change me",
            "source_table": "",
            "destination_table": "",
            "enabled": false,
            "update": false,
            "add": false,
            "delete": false,
            "actions": false,
            "move": false,
            "delete_all": false,
            "autogenerate_key": false,
            "disable_dest_lookup": false,
            "all_fields": false,
            "continue_on_error": null,
            "comments": []
          }
        ],
        "sorting_source_table": {
          "list": [
            {
              "field_name": "rthdrthdrth",
              "disabled": false
            }
          ],
          "comments": null
        },
        "sorting_destination_table": {
          "list": [
            {
              "field_name": "drthgrth",
              "disabled": false
            }
          ],
          "comments": null
        },
        "special_setup": {
          "source_view_name": "dhydyh",
          "destination_view_name": "drthdrth",
          "comments": []
        },
        "comments": []
      }
    ],
    "actions_table": {
      "action_table_name": "my action2",
      "action_control_field": "field",
      "comments": []
    },
    "actions_table_filters": {
      "action_table_name": "my action2",
      "action_control_field": "field",
      "comments": []
    },
    "triggers": {
      "source_pre_execution": "sp1",
      "source_post_execution": "sp2",
      "destination_pre_execution": "dp1",
      "destination_post_execution": "dp2",
      "comments": []
    },
    "sorting_source_table": {
      "list": [
        {
          "field_name": "sorting_source_field_name",
          "disabled": false
        }
      ],
      "comments": null
    },
    "sorting_destination_table": {
      "list": [
        {
          "field_name": "sorting_destination_field_name",
          "disabled": false
        }
      ],
      "comments": null
    },
    "special_setup": {
      "source_view_name": "sv1",
      "destination_view_name": "sv2",
      "comments": []
    },
    "comments": [
      {
        "created_at": "2022-06-15T15:53:21Z",
        "created_by": "user_22",
        "comment": "<p>nl,km</p>"
      },
      {
        "created_at": "2022-06-15T15:56:19Z",
        "created_by": "user_22",
        "comment": null
      }
    ]
  }
]