GET api/access/v1/plants/{plantId}/contracts

List contracts 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

Body Parameters

None.

Response Information

Resource Description

List of contracts for the specified plant

Collection of Contract

Name	Type	Additional information
Id	globally unique identifier	None.
Name	string	None.
StartDate	date	None.
EndDate	date	None.
IsActive	boolean	None.
IsExternal	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": "62670cf2-4bce-498a-b393-86d2b32ad2a8",
    "Name": "sample string 2",
    "StartDate": "2023-02-21T06:26:51.7756578+00:00",
    "EndDate": "2023-02-21T06:26:51.7756578+00:00",
    "IsActive": true,
    "IsExternal": true
  },
  {
    "Id": "62670cf2-4bce-498a-b393-86d2b32ad2a8",
    "Name": "sample string 2",
    "StartDate": "2023-02-21T06:26:51.7756578+00:00",
    "EndDate": "2023-02-21T06:26:51.7756578+00:00",
    "IsActive": true,
    "IsExternal": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfContract xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSG.Endpoints.ITOps.DataAPI.Logic.Models.Access">
  <Contract>
    <EndDate>2023-02-21T06:26:51.7756578+00:00</EndDate>
    <Id>62670cf2-4bce-498a-b393-86d2b32ad2a8</Id>
    <IsActive>true</IsActive>
    <IsExternal>true</IsExternal>
    <Name>sample string 2</Name>
    <StartDate>2023-02-21T06:26:51.7756578+00:00</StartDate>
  </Contract>
  <Contract>
    <EndDate>2023-02-21T06:26:51.7756578+00:00</EndDate>
    <Id>62670cf2-4bce-498a-b393-86d2b32ad2a8</Id>
    <IsActive>true</IsActive>
    <IsExternal>true</IsExternal>
    <Name>sample string 2</Name>
    <StartDate>2023-02-21T06:26:51.7756578+00:00</StartDate>
  </Contract>
</ArrayOfContract>