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 ClientSecret

URI 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 Requirement

Name	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": "2023-02-16T00:07:47.4985967+00:00",
    "ValidToDate": "2023-02-16T00:07:47.4985967+00:00",
    "IsExternalRequirement": true,
    "IsInternalRequirement": true,
    "IsActive": true,
    "QualificationId": "74c6dc9b-1cce-4d32-9009-46d1f819b8c6",
    "ZoneId": "d7e5f3c1-33be-410d-9709-ef1b911ecca4"
  },
  {
    "Name": "sample string 1",
    "Description": "sample string 2",
    "ValidFromDate": "2023-02-16T00:07:47.4985967+00:00",
    "ValidToDate": "2023-02-16T00:07:47.4985967+00:00",
    "IsExternalRequirement": true,
    "IsInternalRequirement": true,
    "IsActive": true,
    "QualificationId": "74c6dc9b-1cce-4d32-9009-46d1f819b8c6",
    "ZoneId": "d7e5f3c1-33be-410d-9709-ef1b911ecca4"
  }
]

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>74c6dc9b-1cce-4d32-9009-46d1f819b8c6</QualificationId>
    <ValidFromDate>2023-02-16T00:07:47.4985967+00:00</ValidFromDate>
    <ValidToDate>2023-02-16T00:07:47.4985967+00:00</ValidToDate>
    <ZoneId>d7e5f3c1-33be-410d-9709-ef1b911ecca4</ZoneId>
  </Requirement>
  <Requirement>
    <Description>sample string 2</Description>
    <IsActive>true</IsActive>
    <IsExternalRequirement>true</IsExternalRequirement>
    <IsInternalRequirement>true</IsInternalRequirement>
    <Name>sample string 1</Name>
    <QualificationId>74c6dc9b-1cce-4d32-9009-46d1f819b8c6</QualificationId>
    <ValidFromDate>2023-02-16T00:07:47.4985967+00:00</ValidFromDate>
    <ValidToDate>2023-02-16T00:07:47.4985967+00:00</ValidToDate>
    <ZoneId>d7e5f3c1-33be-410d-9709-ef1b911ecca4</ZoneId>
  </Requirement>
</ArrayOfRequirement>