Develop > Application Programming Interface > Legacy APIs > Artifact API > View an artifact

View an artifact

Details

URI /artifact/<artifact_id>
Method GET
Parameters

userIdentifier=<user_id>

 Required; the user ID you want to use as credentials for this API call. See Get userIdentifier for the steps required to get the userIdentifier value.

scope=[base|baseplusone|subtree|view]

  Optional; default is base. If value is base, then the object is returned. If value is baseplusone, then the object and its first level children are returned. If value is subtree, then the object and all of its descendants are returned. If the value is vie, then the view parameter is required.

detail=[required|basic|standard|template|full]

  Optional; default is full. See Values for the detail parameter

Note Some API calls do not support all possible values for this parameter.

detail=FULL, even as the default value, is not accepted for organization artifacts because the volume of content returned can be excessively large. Specify detail=BASIC to avoid an exception message.

view=<view_type>

    Required when value for scope is view; if this parameter is defined, then the value for scope is processed as if its value was view. The default is basicinfo. See Artifact views for a list of view types.

restrict=[true|false]

 Optional; default is true. If the value is true, then the output fields of the REST response are restricted. By default, the following fields are not displayed: createdBy, updatedBy, createdOn, updatedOn, description, iconUrl, and categoryType. If the value is false, then the output fields are displayed.

For more information, see Values for the restrict parameter
Returns 200 - Ok
401 - Not authorized
404 - Object not found
500 - Server exception

Examples

Use the following URL:

https://<host>:<port>/csa/rest/artifact/90e72e4f3b00a69e013b0bf7ed55002e?userIdentifier=<user_id>

The following XML was returned in the response:

<ResourceEnvironment>
  <id>90e72e4f3b00a69e013b0bf7ed55002e</id>
  <objectId>90e72e4f3b00a69e013b0bf7ed55002e</objectId>
  <createdOn>2012-11-16T17:24:55.765-08:00</createdOn>
  <updatedOn>2012-11-16T17:24:55.765-08:00</updatedOn>
  <createdBy>
    <id>90d96588360da0c701360da0f1d5f483</id>
    <objectId>90d96588360da0c701360da0f1d5f483</objectId>
    <isCriticalSystemObject>true</isCriticalSystemObject>
    <name>admin</name>
    <displayName>admin</displayName>
    <disabled>false</disabled>
  </createdBy>
  <updatedBy>
    <id>90d96588360da0c701360da0f1d5f483</id>
    <objectId>90d96588360da0c701360da0f1d5f483</objectId>
    <isCriticalSystemObject>true</isCriticalSystemObject>
    <name>admin</name>
    <displayName>admin</displayName>
    <disabled>false</disabled>
  </updatedBy>
  <isCriticalSystemObject>false</isCriticalSystemObject>
  <description>TestEnv</description>
  <name>TestEnv_November 17, 2012 1:24:55 AM UTC</name>
  <displayName>TestEnv</displayName>
  <state>
    <id>90d96588360da0c701360da0ef470038</id>
    <objectId>90d96588360da0c701360da0ef470038</objectId>
    <createdOn>2012-11-01T15:16:54.687-07:00</createdOn>
    <isCriticalSystemObject>true</isCriticalSystemObject>
    <description>Active</description>
    <iconUrl>/csa/images/categories/artifact_state/active.png</iconUrl>
    <name>ACTIVE</name>
    <displayName>Active</displayName>
    <disabled>false</disabled>
    <categoryType>
       <id>90d96588360da0c701360da0ef420037</id>
      <objectId>90d96588360da0c701360da0ef420037</objectId>
      <isCriticalSystemObject>true</isCriticalSystemObject>
      <name>ARTIFACT_STATE</name>
      <displayName>Artifact State</displayName>
      <extensible>false</extensible>
    </categoryType>
  </state>
  <artifactType>
    <id>90d96588360da0c701360da0eedb0020</id>
    <objectId>90d96588360da0c701360da0eedb0020</objectId>
    <createdOn>2012-11-01T15:16:57.787-07:00</createdOn>
    <isCriticalSystemObject>true</isCriticalSystemObject>
    <description>Resource Environment</description>
    <iconUrl>
      /csa/images/categories/artifact_type/resource_environment.png
    </iconUrl>
    <name>RESOURCE_ENVIRONMENT</name>
    <displayName>Resource Environment</displayName>
    <disabled>false</disabled>
    <categoryType>
    <id>90d96588360da0c701360da0eeb40017</id>
      <objectId>90d96588360da0c701360da0eeb40017</objectId>
      <isCriticalSystemObject>true</isCriticalSystemObject>
      <name>ARTIFACT_TYPE</name>
      <displayName>Artifact Type</displayName>
      <extensible>false</extensible>
    </categoryType>
  </artifactType>
  <disabled>false</disabled>
  <numberOfProvider>0</numberOfProvider>
  <numberOfServiceDesign>0</numberOfServiceDesign>
  <numberOfCatalog>0</numberOfCatalog>
</ResourceEnvironment>

Send Help Center feedback