Documentation Powered by ReDoc

Access Risk Management Utilization Tracking (v1)

Download OpenAPI specification:Download

ChangeDocument

Responsible for creating a new Change Document record, based on the supplied model.

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

Represents the Change Document model that will be created.

id
integer <int64>
emergencyAccessRequestId
string <uuid>
erpSystemId
integer <int32>
documentData
string Nullable
createdDateUtc
string <date-time>
createdBy
string Nullable
updatedDateUtc
string <date-time> Nullable
updatedBy
string Nullable

Responses

Request samples

Content type
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
{
  • "id": 0,
  • "emergencyAccessRequestId": "b6925f5a-2fec-4281-beb4-19df5c47319b",
  • "erpSystemId": 0,
  • "documentData": "string",
  • "createdDateUtc": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "updatedDateUtc": "2019-08-24T14:15:22Z",
  • "updatedBy": "string"
}

Response samples

Content type
text/plain
text/plain
application/json
text/json
No sample

Responsible for updating an existing Change Document record, based on the supplied model.

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

Represents the Change Document model that will be updated.

id
integer <int64>
emergencyAccessRequestId
string <uuid>
erpSystemId
integer <int32>
documentData
string Nullable
createdDateUtc
string <date-time>
createdBy
string Nullable
updatedDateUtc
string <date-time> Nullable
updatedBy
string Nullable

Responses

Request samples

Content type
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json
{
  • "id": 0,
  • "emergencyAccessRequestId": "b6925f5a-2fec-4281-beb4-19df5c47319b",
  • "erpSystemId": 0,
  • "documentData": "string",
  • "createdDateUtc": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "updatedDateUtc": "2019-08-24T14:15:22Z",
  • "updatedBy": "string"
}

Response samples

Content type
text/plain
text/plain
application/json
text/json
No sample

Returns a Change Document record, based on the supplied change document identifier.

path Parameters
changeDocumentId
required
integer <int64>

Represents the Change Document identifier.

Responses

Response samples

Content type
text/plain
text/plain
application/json
text/json
No sample

Returns a collection of Change Document records, based on the supplied emergency access request identifier.

path Parameters
emergencyAccessRequestId
required
string <uuid>

Represents the Emergency Access Request identifier.

Responses

Response samples

Content type
text/plain
text/plain
application/json
text/json
No sample

Determines if there are any Change Document record(s) for the given emergencyAccessRequestId.

path Parameters
emergencyAccessRequestId
required
string <uuid>

Represents the unique identifier of the Emergency Access Request.

Responses

Response samples

Content type
text/plain
text/plain
application/json
text/json
No sample

EamUtilization

Returns a boolean indicating if the specified EAM request has utilization data on UTS

path Parameters
eamRequestId
required
string <uuid>

Id for EAM Request

Responses