Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Initiatives

Get List of Initiatives

Use this API to retrieve a list of all initiatives or search for initiatives based on the specified criteria.

post/v1/initiatives/search

Query parameters

pageinteger

Results page to be retrieved (0..N). Example- '?page=1

The page number of the results.

sizeinteger

Number of records per page (1..50). Example- '?size=20

The number of results per page.

sort'id,asc' | 'id,desc' | 'number,asc' | 'number,desc' | 'name,asc' | 'name,desc' | 'createdDate,asc' | 'createdDate,desc'

The sort criteria that dictates the order of the results.

Request body

Response

Initiatives fetched successfully

idstring uuid

The unique identifier of the initiative.

numberinteger

The sequential order in which the initiative was created.

namestring

The name of the initiative.

orgGroupIdstring uuid

The unique identifier of the organization accountable for managing the initiative.

complianceScoreinteger

The compliance score of the initiative.

scopeIdstring uuid

The unique identifier of the inventory record associated with the iniatiative.

scopeNamestring

The name of the inventory record associated with the initiative.

scopeTypestring

The type of inventory record associated with the initiative.

organizationNamestring

The name of the organization accountable for managing the initiative.

observationStartDTstring date-time

The start date and time for which the initiative will be observed.

observationEndDTstring date-time

The end date and time for which the initiative will be observed.

creationStatusstring

The creation status of the initiative.

Example response

[
  {
    "id": "ab129a431-3d3d-4352-9daf-71f6ea2b3d70",
    "number": 1,
    "name": "NIST 800-53 Compliance Initiative",
    "orgGroupId": "cb49a431-3d3d-4352-9daf-71f6ea2b3d89",
    "complianceScore": 76,
    "scopeId": "9a038a54-5842-49c5-920e-06e74f7cff9e",
    "scopeName": "Azure SQL Server",
    "scopeType": "Assets",
    "organizationName": "OneTrust HR",
    "legislations": [
      {
        "name": "GDPR Privacy (2018)",
        "frameworkId": "cb49a431-3d3d-4352-9daf-71f6ea2b3d89",
        "otFrameworkIdentifier": "78a6237c-f99e-4d18-9dcb-fea88a72f0fd"
      }
    ],
    "observationStartDT": "2024-01-01T23:59:59Z",
    "observationEndDT": "2025-12-31T23:59:59Z",
    "owners": [
      {
        "id": "cb49a431-3d3d-4352-9daf-71f6ea2b3d89",
        "active": true,
        "name": "John Smith"
      }
    ],
    "creationStatus": "SUCCESS",
    "inventories": [
      {
        "id": "ab129a431-3d3d-4352-9daf-71f6ea2b3d70",
        "name": "Azure SQL Server",
        "inventoryType": "Assets",
        "number": 1
      }
    ],
    "workflowAndStage": {
      "id": "b271c01a-89a9-41b1-8185-0a3e2bfdad84",
      "name": "Vendor On-Boarding Workflow",
      "type": "Vendor",
      "workflowMode": "BASIC",
      "stageId": "9fc111cb-c379-4f08-8aff-5be954c1a6e6",
      "stageName": "Start On-Boarding"
    },
    "auditFields": {
      "createdBy": {
        "id": "c21319953-b4b5-4042-8cb9-b78038cc4c51",
        "name": "Name"
      },
      "lastModifiedBy": {
        "id": "c21319953-b4b5-4042-8cb9-b78038cc4c51",
        "name": "Name"
      }
    }
  }
]