CSA API - retrieve service instance properties

Hi all,

 

We are using CSA REST API to retrieve the detail information of the service instance of one subscription. But looks like only those consumer visible properties are able to be retrieved in the response of the REST api: /csa/api/mpp/mpp-instance. (we tried the artifact API as well.)

There is on property (deploy visible only) we want to be able to retrieve it from the API, are we able to do this without make it consumer visible( visible on the MPP )?

Thank you so much

 

Regards

Ryan

Tags:

  • Verified Answer

    ru talking about properties of components in the service instance?

    if so you can traverse the instance tree with the artificat API and also read consumer unvisible attributes

     

    https://<host>:8444/csa/rest/artifact/<componentid>?userIdentifier=90d96588360da0c701360da0f1d600a1&scope=subtree"

     

    this will give you something like below where you can see consumerVisible=false

     

    <ServiceComponent>
    <id>8618f0d1721c98660172a492c6934ada</id>
    <objectId>8618f0d1721c98660172a492c6934ada</objectId>
    <createdOn>2020-06-11T20:09:42.035 02:00</createdOn>
    <updatedOn>2020-06-12T00:04:59.926 02:00</updatedOn>
    <isCriticalSystemObject>false</isCriticalSystemObject>
    <description>The Server (Optionally, marked as a pattern) component type provides specific provisioning attributes for individual Servers, or for all Servers in a Server Group when marked as a pattern.</description>
    <iconUrl>/csa/images/categories/component_type/server.png</iconUrl>
    <name>688c99af-f402-aad4-0b8a-96fdaeed161d</name>
    <displayName>Server</displayName>

    <property>
    <id>8618f0d1721c98660172a492c6954bb6</id>
    <objectId>8618f0d1721c98660172a492c6954bb6</objectId>
    <createdOn>2020-06-11T20:09:42.037 02:00</createdOn>
    <updatedOn>2020-06-11T20:09:42.037 02:00</updatedOn>
    <isCriticalSystemObject>false</isCriticalSystemObject>
    <name>BUSINESS_CONTACT</name>
    <displayName>INTERNAL_BUSINESS_CONTACT</displayName>

    <maxOccurs>1</maxOccurs>
    <minOccurs>0</minOccurs>
    <orderIndex>-1</orderIndex>
    <confidential>false</confidential>
    <encrypted>false</encrypted>
    <consumerReadOnly>false</consumerReadOnly>
    <consumerVisible>false</consumerVisible>
    <measurable>false</measurable>
    <multiplied>false</multiplied>
    <upgradeLocked>false</upgradeLocked>
    <newPropertyOnUpgrade>false</newPropertyOnUpgrade>
    </property>

    <designerVisible>true</designerVisible>
    <serverType>false</serverType>
    </ServiceComponent>

  • Thank you so much Michael,
    This is the API call we are using now, was using the service-instance ones.