{"_id":"56b8d74d86d2b0190070bd7a","category":{"_id":"56b8cdab14feef0d0082415d","__v":5,"pages":["56b8cdd914feef0d0082415e","56b8cebd38b1070d00289220","56b8d26f38b1070d00289226","56b8d3a55d75fe0d00fbcca5","56b8d74d86d2b0190070bd7a"],"project":"569f9cf6650e1d1900f96b5b","version":"569f9cf6650e1d1900f96b5e","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-02-08T17:17:31.562Z","from_sync":false,"order":9999,"slug":"migration-methods","title":"Migration methods"},"project":"569f9cf6650e1d1900f96b5b","version":{"_id":"569f9cf6650e1d1900f96b5e","project":"569f9cf6650e1d1900f96b5b","__v":12,"createdAt":"2016-01-20T14:43:02.785Z","releaseDate":"2016-01-20T14:43:02.785Z","categories":["569f9cf7650e1d1900f96b5f","56abdd81d4432d1900eed235","56abe0558beeff0d003b8118","56ad2f8b1c09150d00a183a8","56ad4e1cd21f1b0d00fd2f97","56b00ad88f7a4f0d0029dc92","56b2432e9621f20d00efb2bd","56b25826147e900d00d6497a","56b7af2a4b372d2100722c48","56b8c4d938b1070d0028920f","56b8cdab14feef0d0082415d","58599813cf9e112d0032cdab"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"__v":6,"user":"5582e90181672a3900bb4fc7","githubsync":"","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-08T17:58:37.208Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","examples":{"codes":[]},"results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":4,"body":"## Syntax \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    <credentials object> \\n    \\\"job\\\":<job id>, \\n    \\\"user\\\":<username>\\n}\",\n      \"language\": \"perl\",\n      \"name\": \"  \"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Request fields for migration_trace\"\n}\n[/block]\nThe following fields can be used in the **migration_trace** method:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field name\",\n    \"h-1\": \"Obligation\",\n    \"h-2\": \"Definition/Value\",\n    \"0-0\": \"job\",\n    \"0-1\": \"Required\",\n    \"0-2\": \"The ID of the job you are querying. The ID is returned in the [migration_add](https://api-opensrs-email.readme.io/v1.0/docs/migration_add?bypass=8272e34bb5) response.\",\n    \"1-0\": \"user\",\n    \"1-1\": \"Required\",\n    \"1-2\": \"The username of the person whose migration job is being retrieved.\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response fields for migration_trace\"\n}\n[/block]\nThe following fields may be returned when the **migration_trace** method is submitted:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field name\",\n    \"h-1\": \"Obligation\",\n    \"h-2\": \"Description/Value\",\n    \"0-0\": \"error\",\n    \"0-1\": \"Returned if **success = false**\",\n    \"0-2\": \"A text string that explains the error.\",\n    \"1-0\": \"error_number\",\n    \"1-1\": \"Returned if **success = false**\",\n    \"1-2\": \"A number that represents the error.\",\n    \"2-0\": \"success\",\n    \"2-1\": \"Always returned\",\n    \"2-2\": \"Indicates whether the requested change was successful or not. Allowed values are **true** and **false**.\",\n    \"3-0\": \"trace\",\n    \"3-1\": \"Returned if **success = true**\",\n    \"3-2\": \"The URL where the trace file can be downloaded. The trace file provides detailed information about the migration job.\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Examples for migration_trace\"\n}\n[/block]\n**Request** \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"credentials\\\": {\\n    \\\"user\\\": \\\"domain_admin:::at:::example.com\\\",\\n    \\\"password\\\": \\\"sw0rdf1sh\\\"\\n  },\\n  \\\"user\\\": \\\"joe_user@example.com\\\",\\n  \\\"job\\\": \\\"1326229437638\\\"\\n}\",\n      \"language\": \"perl\",\n      \"name\": \"  \"\n    }\n  ]\n}\n[/block]\n**Response** \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n\\t\\\"success\\\": true,\\n  \\\"trace\\\":\\\"https://admin.a.hostedemail.com/api/oma_file/get?type=migrat iontrace&id=joe_user%40democo.com%3A1326229437638&user=domain_admin%40d emoco.com&token=44d904b456a2ffe0c0e77653e0ac44e9\\\"\\n}\",\n      \"language\": \"perl\",\n      \"name\": \"  \"\n    }\n  ]\n}\n[/block]","excerpt":"The **migration_trace** method retrieves detailed information about a single\nuser in a current or historical migration job.\n\nMigration trace files are not available until the migration has started.","slug":"migration_trace","type":"basic","title":"migration_trace"}

migration_trace

The **migration_trace** method retrieves detailed information about a single user in a current or historical migration job. Migration trace files are not available until the migration has started.

## Syntax [block:code] { "codes": [ { "code": "{\n <credentials object> \n \"job\":<job id>, \n \"user\":<username>\n}", "language": "perl", "name": " " } ] } [/block] [block:api-header] { "type": "basic", "title": "Request fields for migration_trace" } [/block] The following fields can be used in the **migration_trace** method: [block:parameters] { "data": { "h-0": "Field name", "h-1": "Obligation", "h-2": "Definition/Value", "0-0": "job", "0-1": "Required", "0-2": "The ID of the job you are querying. The ID is returned in the [migration_add](https://api-opensrs-email.readme.io/v1.0/docs/migration_add?bypass=8272e34bb5) response.", "1-0": "user", "1-1": "Required", "1-2": "The username of the person whose migration job is being retrieved." }, "cols": 3, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "Response fields for migration_trace" } [/block] The following fields may be returned when the **migration_trace** method is submitted: [block:parameters] { "data": { "h-0": "Field name", "h-1": "Obligation", "h-2": "Description/Value", "0-0": "error", "0-1": "Returned if **success = false**", "0-2": "A text string that explains the error.", "1-0": "error_number", "1-1": "Returned if **success = false**", "1-2": "A number that represents the error.", "2-0": "success", "2-1": "Always returned", "2-2": "Indicates whether the requested change was successful or not. Allowed values are **true** and **false**.", "3-0": "trace", "3-1": "Returned if **success = true**", "3-2": "The URL where the trace file can be downloaded. The trace file provides detailed information about the migration job." }, "cols": 3, "rows": 4 } [/block] [block:api-header] { "type": "basic", "title": "Examples for migration_trace" } [/block] **Request** [block:code] { "codes": [ { "code": "{\n \"credentials\": {\n \"user\": \"domain_admin@example.com\",\n \"password\": \"sw0rdf1sh\"\n },\n \"user\": \"joe_user@example.com\",\n \"job\": \"1326229437638\"\n}", "language": "perl", "name": " " } ] } [/block] **Response** [block:code] { "codes": [ { "code": "{\n\t\"success\": true,\n \"trace\":\"https://admin.a.hostedemail.com/api/oma_file/get?type=migrat iontrace&id=joe_user%40democo.com%3A1326229437638&user=domain_admin%40d emoco.com&token=44d904b456a2ffe0c0e77653e0ac44e9\"\n}", "language": "perl", "name": " " } ] } [/block]