Listing rendering values for shutdown areas

For each shutdown area that is defined for a service order, list the assets to render on the map. Render values such as color and icon are included for each asset. Typically, a service order is linked to at most one shutdown area. Each shutdown area includes the assets that must be shut off or isolated to manage scheduled or emergency asset repair. For example, a number of valves might need to be shut off before one or more pipes can be repaired. A shutdown area also typically includes one or more assets that are affected by the shutdown, and might also include service delivery points that are affected by the shutdown, for example, a school.

Method

GET.

Resource URL

https://web_server_hostname/ibm/water/vds/api/shutdownarea/serviceorder/SO_ID/rendervalues

For example,

https://web-server.cn.example.com/ibm/water/vds/api/shutdownarea/serviceorder/21/rendervalues

Path parameters

The following table describes the path parameter:

Name	Type	Description
SO_ID	Integer	The ID of the service order.

Response properties

An array of objects is returned in the response. Each object represents a shutdown area, and includes details of the assets to render on the map:

Table 1. Response properties
Name	Type	Description
ASSET_ID	String	The integer ID of the asset.
ASSET_TYPE_ID	String	The string ID of the asset type.
ASSET_TYPE_NAME	Object	An object containing the key and group values that represent the name of the asset type.
ASSET_TYPE_NAME_I18N	String	The I18N string for the name of the asset type.
ID	String	The string ID of the asset.
LOCATION	String	Geographical coordinates for the asset.
MODEL_ID	String	The ID of the model.
NAME	String	The name of the asset.
RELATIONSHIP_NAME	Object	An object containing the key and group values that represent the relationship between the asset and the shutdown area.
RELATIONSHIP_NAME_I18N	String	The I18N string for the name of the relationship type that describes the relationship between the asset and the shutdown area.
RELATIONSHIP_TYPE_ID	String	The ID of the relationship type that describes the relationship between the asset and the shutdown area.
RENDER_COLOR	String	The hex value representing the color of the asset on the map.
RENDER_ICON	String	The image file for the asset icon.
RENDER_THICKNESS	String	The defined thickness value to use when rendering the asset. The value is null if a thickness is not defined.
SHUTDOWN_ID	String	The ID of the shutdown area asset.
SOLUTION_ID	String	The ID of the solution.
TYPE_ID	String	The integer ID of the asset type.

Sample response content

[
   {
      "LOCATION": "POINT (-6.2282181 53.3472722)",
      "RENDER_COLOR": "#000000",
      "RENDER_THICKNESS": null,
      "SOLUTION_ID": "VDSMultiTenant",
      "RELATIONSHIP_NAME_I18N": "Target Asset Of Shutdown Area",
      "RELATIONSHIP_NAME": {
         "key": "VDSMultiTenant_model_VEOLIA_relationshipType_targetAssetOfShutdownArea_name",
         "group": "VDSMultiTenant"
      },
      "SHUTDOWN_ID": "dhShutdownArea_1011_cucmtest",
      "RENDER_ICON": "other.png",
      "ASSET_TYPE_NAME_I18N": "Pipeline Segment",
      "ASSET_ID": "5426",
      "NAME": "Pipe 9985",
      "MODEL_ID": "VEOLIA",
      "ASSET_TYPE_NAME": {
         "key": "VDSMultiTenant_model_VEOLIA_assetType_dhPipeSegment_name",
         "group": "VDSMultiTenant"
      },
      "TYPE_ID": "254",
      "ASSET_TYPE_ID": "dhPipeSegment",
      "RELATIONSHIP_TYPE_ID": "targetAssetOfShutdownArea",
      "ID": "dhPipeSegment_1011_Pipe9985"
   }
]