Get Service Instance Artifact method

Use the Get Service Instance Artifact method to receive a service instance artifact. For example, you can use this method to request the process report for a service instance.

HTTP method: GET

URI: /monitor/connection_name/execution_id/artifact_name

Request payload content type: None

Response payload content type: application/xml

Expected response: HTTP/1.1 200 OK

Parameters

The method URI contains the following parameters.

Name Description Required
connection_name Enter the name that identifies the Optim™ directory connection that contains the service instance. Y
execution_id Enter the execution ID that identifies the service instance whose artifacts you want to view. Y
artifact_name Enter the name of the artifact whose content you want to view. Y

Response payload example

The following example shows possible contents of an artifact. Artifacts are text-based files that are either in XML format or text format. Use artifacts to troubleshoot issues with a service.
/OUTPUT PSTDIR=OPTDIRORA TYPE=Extract REQUEST=TESTDATA.ERCUST11K STOP=None ERRORLEVEL=0
Extract Process Report


Request Name                    TESTDATA.ERCUST11K
Server Name                     (Local)
Extract File                    C:\IBM\InfoSphere\Optim\data\ERCUST11K.xf
Access Definition               TESTDATA.CUST11K
File Attachments                Processed
Client User ID                  optadmin
Server User ID                  optadmin
Teradata Character Set	          WE8MSWIN1252
Time Started                    5/16/2013 13:03:52
Time Finished                   5/16/2013 13:03:54
Elapsed Time                    00:00:02
Extract File Data Byte Count    0.001 MB
Process Status	no errors, no warnings

Response codes

The following response codes can be received when the method is complete.

Response code Description
200 OK. The artifact was successfully returned.
400 Bad Request. A malformed request was submitted.
404 Not Found. The execution ID does not exist, or the artifact name does not exist for the execution ID.


Feedback