GET api/access/v1/contracts/{contractId}

Get information for the specified contract

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
contractId	Id of the contract	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

Information for the specified contract, if the requester has access to the contract's plant

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": "b5233873-335b-4cc8-b456-1c60b008fb15",
  "Name": "sample string 2",
  "StartDate": "2023-03-19T22:58:56.2401844+00:00",
  "EndDate": "2023-03-19T22:58:56.2401844+00:00",
  "IsActive": true,
  "IsExternal": true
}

application/xml, text/xml

Sample:

<Contract xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSG.Endpoints.ITOps.DataAPI.Logic.Models.Access">
  <EndDate>2023-03-19T22:58:56.2401844+00:00</EndDate>
  <Id>b5233873-335b-4cc8-b456-1c60b008fb15</Id>
  <IsActive>true</IsActive>
  <IsExternal>true</IsExternal>
  <Name>sample string 2</Name>
  <StartDate>2023-03-19T22:58:56.2401844+00:00</StartDate>
</Contract>