resource retrieve report command

The resource retrieve report command retrieves the status report for an import or export job.

Usage notes

The resource retrieve report command and the resource retrieve data command are similar, but have the following differences:

  • Use the resource retrieve report command to retrieve a status report for an import or export job.
  • Use the resource retrieve data command to retrieve the data that was imported or exported as a part of a job.

For example, the resource retrieve report command reports that the threadpool-0001 resource was successfully exported. The resource retrieve data command generates the XML description of the threadpool-0001 resource that was exported.

Environment

  • Windows 2008
  • Linux®

Authorization

Administrative user

Syntax

execute resource retrieve report <path to file> <job_id> <--wait time|-w time>

Option descriptions

path to file
The path to the file that contains the information that is generated by the resource retrieve report command.
job_id
The job ID that is generated for a resource by using the resource export or the resource import command.
--wait and -w
Used to define a period of time, in seconds, before the request times out. If --wait or -w is not used, the default value is 60 seconds. The parameters --wait and -w have the same usage.

Example

Example: Generating a status report for a particular job ID.-
This command generates a status report for job ID 1eaaf183-1f7e-45fe-8ae3-b68a3a905c8b in the resource_retrieve_report001.xml file. The request has 45 seconds to complete.
execute resource retrieve report C:\B2BAC_resources\resource_retrieve_report001.xml 1eaaf183-1f7e-45fe-8ae3-b68a3a905c8b -w 45
Submitting the request...
Time                           Type                 Status               Job ID

11/26/13 1:40 PM               EXPORT               SUCCESS              1eaaf183-1f7e-45fe-8ae3-b68a3a905c8b
The output of this command in resource_retrieve_report001.xml is the following report:
Status report on 2013-11-26 13:40:20.221 for service: Export
PMode :: pmode-0003 :: WRITE :: SUCCESS :: Successfully Exported
PMode :: pmode-0002 :: WRITE :: SUCCESS :: Successfully Exported
PMode :: pmode-0001 :: WRITE :: SUCCESS :: Successfully Exported
ThreadPool :: threadpool-0001 :: WRITE :: SUCCESS :: Successfully Exported
ThreadPool :: threadpool-0002 :: WRITE :: SUCCESS :: Successfully Exported
ThreadPool :: threadpool-0003 :: WRITE :: SUCCESS :: Successfully Exported
End of report