GET api/access/v1/plants/{plantId}/requirements?zoneId={zoneId}&includeAllZones={includeAllZones}
List requirements for a specific plant
Request Information
Requires Authorization!
In order to make a request to work 2 headers are required, a ClientId and a ClientSecretURI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
plantId |
Id of the plant |
globally unique identifier |
Required |
zoneId |
Id of a specific zone |
globally unique identifier |
None. |
includeAllZones |
Set to true if all zone requirements should be returned |
boolean |
None. |
Body Parameters
None.
Response Information
Resource Description
List of requirements for the specified plant and optional zones
Collection of RequirementName | Description | Type | Additional information |
---|---|---|---|
Name | string |
None. |
|
Description | string |
None. |
|
ValidFromDate | date |
None. |
|
ValidToDate | date |
None. |
|
IsExternalRequirement | boolean |
None. |
|
IsInternalRequirement | boolean |
None. |
|
IsActive | boolean |
None. |
|
QualificationId | globally unique identifier |
None. |
|
ZoneId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
[ { "Name": "sample string 1", "Description": "sample string 2", "ValidFromDate": "2024-04-20T15:38:36.7389065+00:00", "ValidToDate": "2024-04-20T15:38:36.7389065+00:00", "IsExternalRequirement": true, "IsInternalRequirement": true, "IsActive": true, "QualificationId": "3286a510-a69a-4ad4-b238-f2d58743bd15", "ZoneId": "0be725e6-c5a9-4e71-97cf-ae936bee6861" }, { "Name": "sample string 1", "Description": "sample string 2", "ValidFromDate": "2024-04-20T15:38:36.7389065+00:00", "ValidToDate": "2024-04-20T15:38:36.7389065+00:00", "IsExternalRequirement": true, "IsInternalRequirement": true, "IsActive": true, "QualificationId": "3286a510-a69a-4ad4-b238-f2d58743bd15", "ZoneId": "0be725e6-c5a9-4e71-97cf-ae936bee6861" } ]
application/xml, text/xml
Sample:
<ArrayOfRequirement xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSG.Endpoints.ITOps.DataAPI.Logic.Models.Access"> <Requirement> <Description>sample string 2</Description> <IsActive>true</IsActive> <IsExternalRequirement>true</IsExternalRequirement> <IsInternalRequirement>true</IsInternalRequirement> <Name>sample string 1</Name> <QualificationId>3286a510-a69a-4ad4-b238-f2d58743bd15</QualificationId> <ValidFromDate>2024-04-20T15:38:36.7389065+00:00</ValidFromDate> <ValidToDate>2024-04-20T15:38:36.7389065+00:00</ValidToDate> <ZoneId>0be725e6-c5a9-4e71-97cf-ae936bee6861</ZoneId> </Requirement> <Requirement> <Description>sample string 2</Description> <IsActive>true</IsActive> <IsExternalRequirement>true</IsExternalRequirement> <IsInternalRequirement>true</IsInternalRequirement> <Name>sample string 1</Name> <QualificationId>3286a510-a69a-4ad4-b238-f2d58743bd15</QualificationId> <ValidFromDate>2024-04-20T15:38:36.7389065+00:00</ValidFromDate> <ValidToDate>2024-04-20T15:38:36.7389065+00:00</ValidToDate> <ZoneId>0be725e6-c5a9-4e71-97cf-ae936bee6861</ZoneId> </Requirement> </ArrayOfRequirement>