Develop > Application Programming Interface > Legacy APIs > Organization API > View an organization

View an Organization

Details

URI /organization/<organization_id>.
See View a List of Organizations to get the organization ID.
Method GET
Parameters

userIdentifier=<user_id>
Required; the user ID you want to use as credentials for this API call. This user should be a consumer user who has the necessary permissions for the data you want to work with. See Get userIdentifier for the steps required to get the userIdentifier value.  

scope=[base|baseplusone]
Optional; default is base. If value is base, then the object is returned. If value is baseplusone, then the base plus the first level children are returned. Note that subtree is not a valid value for this API call.

detail=[required|basic]
Optional; default is basic. See Values for the detail Parameter.

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.

See Values for the restrict Parameter for more information.
Returns 200 - Ok
401 - Not authorized
404 - Not found
500 - Server exception

Example

The following URL is sent:

https://localhost:8444/csa/rest/organization/8a8181853810699a0138106dcdd00003/ ?userIdentifier=8a8181853810699a01381076be5400a0

The following XML is returned:

<Organization>
   <id>8a8181853810699a0138106dcdd00003</id>
   <objectId>8a8181853810699a0138106dcdd00003</objectId>
   <createdOn>2012-06-21T12:03:47.920-07:00</createdOn>
   <updatedOn>2012-06-21T12:04:10.597-07:00</updatedOn>
   <isCriticalSystemObject>false</isCriticalSystemObject>
   <description>desc - CSA organization</description>
   <iconUrl>/csa/images/library/Earth_48.png</iconUrl>
   <name>CSA</name>
   <displayName>CSA</displayName>
   <state>
      <id>90d96588360da0c701360da0ef470038</id>
      <objectId>90d96588360da0c701360da0ef470038</objectId>
      <createdOn>2012-06-21T11:51:43.267-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>90d96588360da0c701360da0eefc002a</id>
      <objectId>90d96588360da0c701360da0eefc002a</objectId>
      <createdOn>2012-06-21T11:51:43.253-07:00</createdOn>
      <isCriticalSystemObject>true</isCriticalSystemObject>
      <description>Organization</description>
      <iconUrl>/csa/images/categories/artifact_type/organization.png</iconUrl>
      <name>ORGANIZATION</name>
      <displayName>Organization</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>
   <partyType>
      <id>90d96588360da0c701360da0eff1005d</id>
      <objectId>90d96588360da0c701360da0eff1005d</objectId>
      <createdOn>2012-06-21T11:51:43.293-07:00</createdOn>
      <isCriticalSystemObject>true</isCriticalSystemObject>
      <description>Organization</description>
      <iconUrl>/csa/images/categories/party_type/organization.png</iconUrl>
      <name>ORGANIZATION</name>
      <displayName>Organization</displayName>
      <disabled>false</disabled>
      <categoryType>
         <id>90d96588360da0c701360da0efe20059</id>
         <objectId>90d96588360da0c701360da0efe20059</objectId>
         <isCriticalSystemObject>true</isCriticalSystemObject>
         <name>PARTY_TYPE</name>
         <displayName>Party Type</displayName>
         <extensible>false</extensible>
      </categoryType>
   </partyType>
   <businessRole>
      <id>90d96588360da0c701360da0f0020061</id>
      <objectId>90d96588360da0c701360da0f0020061</objectId>
      <createdOn>2012-06-21T11:51:43.300-07:00</createdOn>
      <isCriticalSystemObject>true</isCriticalSystemObject>
      <description>Consumer</description>
      <iconUrl>/csa/images/categories/business_role/consumer.png</iconUrl>
      <name>CONSUMER</name>
      <displayName>Consumer</displayName>
      <disabled>false</disabled>
      <categoryType>
         <id>90d96588360da0c701360da0effd0060</id>
         <objectId>90d96588360da0c701360da0effd0060</objectId>
         <isCriticalSystemObject>true</isCriticalSystemObject>
         <name>BUSINESS_ROLE</name>
         <displayName>Business Role</displayName>
         <extensible>false</extensible>
      </categoryType>
   </businessRole>
</Organization>

Send Help Center feedback