Project

Project Management Service APIs

Facilitate the management of projects.

Create a new Project

Create a new Project

POST/project/v1/_create

Body

application/json

Details for the new Project.

Projectsarray of Project (object)

Response

202400

Project request accepted for creation.

Body

*/*

Projectsarray of Project (object)

Request

JavaScriptCurlPython

const response = await fetch('/project/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

202

{
  "Projects": [
    {
      "id": "text",
      "tenantId": "tenantA",
      "name": "text",
      "projectNumber": "PR/2022-23/010",
      "projectType": "text",
      "projectSubType": "text",
      "department": "text",
      "description": "text",
      "referenceID": "text",
      "natureOfWork": "text",
      "projectHierarchy": "text",
      "startDate": 0,
      "endDate": 0,
      "isTaskEnabled": false,
      "parent": "text",
      "targets": [
        {
          "id": "text",
          "beneficiaryType": "HOUSEHOLD",
          "baseline": 0,
          "target": 0
        }
      ]
    }
  ]
}

Update the details of a existing Project

Update the details of a existing Project

POST/project/v1/_update

Body

application/json

Details for the new Project.

Projectsarray of Project (object)

Response

202400

Employee request accepted for creation.

Body

*/*

Projectsarray of Project (object)

Request

JavaScriptCurlPython

const response = await fetch('/project/v1/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

202

{
  "Projects": [
    {
      "id": "text",
      "tenantId": "tenantA",
      "name": "text",
      "projectNumber": "PR/2022-23/010",
      "projectType": "text",
      "projectSubType": "text",
      "department": "text",
      "description": "text",
      "referenceID": "text",
      "natureOfWork": "text",
      "projectHierarchy": "text",
      "startDate": 0,
      "endDate": 0,
      "isTaskEnabled": false,
      "parent": "text",
      "targets": [
        {
          "id": "text",
          "beneficiaryType": "HOUSEHOLD",
          "baseline": 0,
          "target": 0
        }
      ]
    }
  ]
}

Search for existing project

Search for existing project

POST/project/v1/_search

Query parameters

Body

application/json

Details for the project.

Projectsarray of Project (object)

Response

200400

Projects.

Body

*/*

Projectsarray of Project (object)

Request

JavaScriptCurlPython

const response = await fetch('/project/v1/_search?limit=0&offset=0&tenantId=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "Projects": [
    {
      "id": "text",
      "tenantId": "tenantA",
      "name": "text",
      "projectNumber": "PR/2022-23/010",
      "projectType": "text",
      "projectSubType": "text",
      "department": "text",
      "description": "text",
      "referenceID": "text",
      "natureOfWork": "text",
      "projectHierarchy": "text",
      "startDate": 0,
      "endDate": 0,
      "isTaskEnabled": false,
      "parent": "text",
      "targets": [
        {
          "id": "text",
          "beneficiaryType": "HOUSEHOLD",
          "baseline": 0,
          "target": 0
        }
      ]
    }
  ]
}

Add beneficiary for project

Add beneficiary for project

POST/project/beneficiary/v1/_create

Body

application/json

Capture details of benificiary type.

ProjectBeneficiaryProjectBeneficiary (object)

A representation of the registration of an entity to a Project.

Response

202400

add beneficiary request has been accepted for creation.

Body

*/*

ProjectBeneficiaryProjectBeneficiary (object)

A representation of the registration of an entity to a Project.

Request

JavaScriptCurlPython

const response = await fetch('/project/beneficiary/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

202

{
  "ProjectBeneficiary": {
    "projectId": "text",
    "beneficiaryId": "text",
    "beneficiaryClientReferenceId": "text"
  }
}

Add beneficiaries for project

Add beneficiaries for project

POST/project/beneficiary/v1/bulk/_create

Body

application/json

Capture details of beneficiary type.

ProjectBeneficiariesarray of ProjectBeneficiary (object)

Response

202400

add beneficiary request has been accepted for creation.

Body

*/*

BulkAcceptedResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('/project/beneficiary/v1/bulk/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

202

{}

Update beneficiary registration for project

Update beneficiary registration for project

POST/project/beneficiary/v1/_update

Query parameters

Body

application/json

Project Beneficiary Registration.

ProjectBeneficiaryProjectBeneficiary (object)

A representation of the registration of an entity to a Project.

Response

202400

Project Beneficiary request has been accepted.

Body

*/*

ProjectBeneficiaryProjectBeneficiary (object)

A representation of the registration of an entity to a Project.

Request

JavaScriptCurlPython

const response = await fetch('/project/beneficiary/v1/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

202

{
  "ProjectBeneficiary": {
    "projectId": "text",
    "beneficiaryId": "text",
    "beneficiaryClientReferenceId": "text"
  }
}

Update beneficiaries registration for project

Update beneficiaries registration for project

POST/project/beneficiary/v1/bulk/_update

Query parameters

Body

application/json

Project Beneficiary Registration.

ProjectBeneficiariesarray of ProjectBeneficiary (object)

Response

202400

Project Beneficiary request has been accepted.

Body

*/*

BulkAcceptedResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('/project/beneficiary/v1/bulk/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

202

{}

Soft delete beneficiary registration for project

Soft delete registration for project

POST/project/beneficiary/v1/_delete

Query parameters

Body

application/json

Soft Delete Project Beneficiary Registration.

ProjectBeneficiaryProjectBeneficiary (object)

A representation of the registration of an entity to a Project.

Response

202400

Project Beneficiary request has been accepted.

Body

*/*

ProjectBeneficiaryProjectBeneficiary (object)

A representation of the registration of an entity to a Project.

Request

JavaScriptCurlPython

const response = await fetch('/project/beneficiary/v1/_delete', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

202

{
  "ProjectBeneficiary": {
    "projectId": "text",
    "beneficiaryId": "text",
    "beneficiaryClientReferenceId": "text"
  }
}

Update beneficiaries registration for project

Update beneficiaries registration for project

POST/project/beneficiary/v1/bulk/_delete

Query parameters

Body

application/json

Project Beneficiary Registration.

ProjectBeneficiariesarray of ProjectBeneficiary (object)

Response

202400

Project Beneficiary request has been accepted.

Body

*/*

BulkAcceptedResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('/project/beneficiary/v1/bulk/_delete', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

202

{}

Search beneficiary registration for Project

Search beneficiary registration for Project

POST/project/beneficiary/v1/_search

Query parameters

Body

application/json

Project Beneficiary Search.

ProjectBeneficiaryProjectBeneficiarySearch (object)

Search model for project beneficiary.

Response

200400

Project Beneficaries.

Body

*/*

ProjectBeneficiariesarray of ProjectBeneficiary (object)

Request

JavaScriptCurlPython

const response = await fetch('/project/beneficiary/v1/_search?limit=0&offset=0&tenantId=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "ProjectBeneficiaries": [
    {
      "projectId": "text",
      "beneficiaryId": "text",
      "beneficiaryClientReferenceId": "text"
    }
  ]
}

Create task for the project

Create task for the project

POST/project/task/v1/_create

Body

application/json

Capture details of Task

Task*Task (object)

Response

202400

Create task request has been accepted for creation.

Body

*/*

Task*Task (object)

Request

JavaScriptCurlPython

const response = await fetch('/project/task/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "Task": {
        "projectId": "text",
        "projectBeneficiaryId": "R-ID-1",
        "resources": [
          {
            "productVariantId": "ID-1",
            "quantity": 0,
            "isDelivered": true
          }
        ]
      }
    }),
});
const data = await response.json();

Response

202

{
  "Task": {
    "projectId": "text",
    "projectBeneficiaryId": "R-ID-1",
    "projectBeneficiaryClientReferenceId": "R-ID-1",
    "resources": [
      {
        "id": "text",
        "productVariantId": "ID-1",
        "quantity": 0,
        "isDelivered": true,
        "deliveryComment": "text"
      }
    ],
    "plannedStartDate": 0,
    "plannedEndDate": 0,
    "actualStartDate": 0,
    "actualEndDate": 0,
    "createdBy": "UUID",
    "createdDate": 1663218161,
    "status": "DELIVERED"
  }
}

Create tasks for the project in bulk

Create tasks for the project in bulk

POST/project/task/v1/bulk/_create

Body

application/json

Capture details of Task

Tasksarray of Task (object)

Response

202400

Create task request has been accepted for creation.

Body

*/*

BulkAcceptedResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('/project/task/v1/bulk/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

202

{}

Task Request

Task Request

POST/project/task/v1/_update

Body

application/json

Capture details of Existing task

Task*Task (object)

Response

202400

update task request has been accepted for update.

Body

*/*

Task*Task (object)

Request

JavaScriptCurlPython

const response = await fetch('/project/task/v1/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "Task": {
        "projectId": "text",
        "projectBeneficiaryId": "R-ID-1",
        "resources": [
          {
            "productVariantId": "ID-1",
            "quantity": 0,
            "isDelivered": true
          }
        ]
      }
    }),
});
const data = await response.json();

Response

202

{
  "Task": {
    "projectId": "text",
    "projectBeneficiaryId": "R-ID-1",
    "projectBeneficiaryClientReferenceId": "R-ID-1",
    "resources": [
      {
        "id": "text",
        "productVariantId": "ID-1",
        "quantity": 0,
        "isDelivered": true,
        "deliveryComment": "text"
      }
    ],
    "plannedStartDate": 0,
    "plannedEndDate": 0,
    "actualStartDate": 0,
    "actualEndDate": 0,
    "createdBy": "UUID",
    "createdDate": 1663218161,
    "status": "DELIVERED"
  }
}

Task Request in bulk for a project

Task Request in bulk for a project

POST/project/task/v1/bulk/_update

Body

application/json

Capture details of Existing tasks

Tasksarray of Task (object)

Response

202400

update tasks bulk request has been accepted for update.

Body

*/*

BulkAcceptedResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('/project/task/v1/bulk/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

202

{}

Soft delete Task for a project

Soft delete Task for a project

POST/project/task/v1/_delete

Body

application/json

Capture details of Existing task

Task*Task (object)

Response

202400

delete task request has been accepted for deletion.

Body

*/*

Task*Task (object)

Request

JavaScriptCurlPython

const response = await fetch('/project/task/v1/_delete', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "Task": {
        "projectId": "text",
        "projectBeneficiaryId": "R-ID-1",
        "resources": [
          {
            "productVariantId": "ID-1",
            "quantity": 0,
            "isDelivered": true
          }
        ]
      }
    }),
});
const data = await response.json();

Response

202

{
  "Task": {
    "projectId": "text",
    "projectBeneficiaryId": "R-ID-1",
    "projectBeneficiaryClientReferenceId": "R-ID-1",
    "resources": [
      {
        "id": "text",
        "productVariantId": "ID-1",
        "quantity": 0,
        "isDelivered": true,
        "deliveryComment": "text"
      }
    ],
    "plannedStartDate": 0,
    "plannedEndDate": 0,
    "actualStartDate": 0,
    "actualEndDate": 0,
    "createdBy": "UUID",
    "createdDate": 1663218161,
    "status": "DELIVERED"
  }
}

Soft delete Tasks for a project

Soft delete Tasks for a project

POST/project/task/v1/bulk/_delete

Body

application/json

Capture details of Existing task

Tasksarray of Task (object)

Response

202400

delete bulk task request has been accepted for deletion.

Body

*/*

BulkAcceptedResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('/project/task/v1/bulk/_delete', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

202

{}

Search task for Project

Search task for Project

POST/project/task/v1/_search

Query parameters

Body

application/json

Project Task Search.

Task*TaskSearch (object)

Response

200400

Project Tasks.

Body

*/*

Tasksarray of Task (object)

Request

JavaScriptCurlPython

const response = await fetch('/project/task/v1/_search?limit=0&offset=0&tenantId=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "Task": {}
    }),
});
const data = await response.json();

Response

200

{
  "Tasks": [
    {
      "projectId": "text",
      "projectBeneficiaryId": "R-ID-1",
      "projectBeneficiaryClientReferenceId": "R-ID-1",
      "resources": [
        {
          "id": "text",
          "productVariantId": "ID-1",
          "quantity": 0,
          "isDelivered": true,
          "deliveryComment": "text"
        }
      ],
      "plannedStartDate": 0,
      "plannedEndDate": 0,
      "actualStartDate": 0,
      "actualEndDate": 0,
      "createdBy": "UUID",
      "createdDate": 1663218161,
      "status": "DELIVERED"
    }
  ]
}

Link Staff users to Project for a certain time period

Link Staff users to Project for a certain time period

POST/project/staff/v1/_create

Body

application/json

Capture linkage of Project and staff user.

ProjectStaff*ProjectStaff (object)

This object defines the mapping of a system staff user to a project for a certain period.

Response

202400

Project Staff request has been accepted.

Body

*/*

ProjectStaff*ProjectStaff (object)

This object defines the mapping of a system staff user to a project for a certain period.

Request

JavaScriptCurlPython

const response = await fetch('/project/staff/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ProjectStaff": {
        "userId": "text",
        "projectId": "text"
      }
    }),
});
const data = await response.json();

Response

202

{
  "ProjectStaff": {
    "id": "text",
    "userId": "text",
    "projectId": "text",
    "startDate": 0,
    "endDate": 0,
    "channel": "text"
  }
}

Link bulk Staff users to Project for a certain time period

Link bulk Staff users to Project for a certain time period

POST/project/staff/v1/bulk/_create

Body

application/json

Capture linkage of Project and staff users.

ProjectStaff*array of ProjectStaff (object)

Response

202400

Project Staff request has been accepted.

Body

*/*

BulkAcceptedResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('/project/staff/v1/bulk/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ProjectStaff": [
        {
          "userId": "text",
          "projectId": "text"
        }
      ]
    }),
});
const data = await response.json();

Response

202

{}

Update Project Staff users

Update Project Staff users

POST/project/staff/v1/_update

Body

application/json

Capture linkage of Project and staff user.

ProjectStaff*ProjectStaff (object)

This object defines the mapping of a system staff user to a project for a certain period.

Response

202400

Project Staff request has been accepted for updation.

Body

*/*

ProjectStaff*ProjectStaff (object)

This object defines the mapping of a system staff user to a project for a certain period.

Request

JavaScriptCurlPython

const response = await fetch('/project/staff/v1/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ProjectStaff": {
        "userId": "text",
        "projectId": "text"
      }
    }),
});
const data = await response.json();

Response

202

{
  "ProjectStaff": {
    "id": "text",
    "userId": "text",
    "projectId": "text",
    "startDate": 0,
    "endDate": 0,
    "channel": "text"
  }
}

Update Project Staff users using bulk payload

Update Project Staff users using bulk payload

POST/project/staff/v1/bulk/_update

Body

application/json

Capture linkage of Project and staff user.

ProjectStaff*array of ProjectStaff (object)

Response

202400

Project Staff bulk request has been accepted for update.

Body

*/*

BulkAcceptedResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('/project/staff/v1/bulk/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ProjectStaff": [
        {
          "userId": "text",
          "projectId": "text"
        }
      ]
    }),
});
const data = await response.json();

Response

202

{}

Soft delete linkage of Project Staff users with project

Soft delete linkage of Project Staff users with project

POST/project/staff/v1/_delete

Body

application/json

Capture linkage of Project and staff user.

ProjectStaff*ProjectStaff (object)

This object defines the mapping of a system staff user to a project for a certain period.

Response

202400

Project Staff request has been accepted for deletion.

Body

*/*

ProjectStaff*ProjectStaff (object)

This object defines the mapping of a system staff user to a project for a certain period.

Request

JavaScriptCurlPython

const response = await fetch('/project/staff/v1/_delete', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ProjectStaff": {
        "userId": "text",
        "projectId": "text"
      }
    }),
});
const data = await response.json();

Response

202

{
  "ProjectStaff": {
    "id": "text",
    "userId": "text",
    "projectId": "text",
    "startDate": 0,
    "endDate": 0,
    "channel": "text"
  }
}

Soft delete linkage of Project Staff users with project in bulk

Soft delete linkage of Project Staff users with project in bulk

POST/project/staff/v1/bulk/_delete

Body

application/json

Capture linkage of Project and staff user.

ProjectStaff*array of ProjectStaff (object)

Response

202400

Project Staff request has been accepted for deletion.

Body

*/*

BulkAcceptedResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('/project/staff/v1/bulk/_delete', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ProjectStaff": [
        {
          "userId": "text",
          "projectId": "text"
        }
      ]
    }),
});
const data = await response.json();

Response

202

{}

Search Project Staff users

Search Project Staff users

POST/project/staff/v1/_search

Query parameters

Body

application/json

Capture linkage of Project and staff user.

ProjectStaff*ProjectStaffSearch (object)

This object defines the mapping of a system staff user to a project for a certain period.

Response

200400

Project Staff.

Body

*/*

ProjectStaff*array of ProjectStaff (object)

Request

JavaScriptCurlPython

const response = await fetch('/project/staff/v1/_search?limit=0&offset=0&tenantId=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ProjectStaff": {}
    }),
});
const data = await response.json();

Response

200

{
  "ProjectStaff": [
    {
      "id": "text",
      "userId": "text",
      "projectId": "text",
      "startDate": 0,
      "endDate": 0,
      "channel": "text"
    }
  ]
}

Link Facility to Project

Link Facility to Project

POST/project/facility/v1/_create

Body

application/json

Capture linkage of Project and facility.

ProjectFacility*ProjectFacility (object)

This object defines the mapping of a facility to a project.

Response

202400

Project Staff request has been accepted.

Body

*/*

ProjectFacility*ProjectFacility (object)

This object defines the mapping of a facility to a project.

Request

JavaScriptCurlPython

const response = await fetch('/project/facility/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ProjectFacility": {
        "facilityId": "text",
        "projectId": "text"
      }
    }),
});
const data = await response.json();

Response

202

{
  "ProjectFacility": {
    "facilityId": "text",
    "projectId": "text"
  }
}

Link Facilities to Project

Link Facilities to Project

POST/project/facility/v1/bulk/_create

Body

application/json

Capture linkage of Project and facility.

ProjectFacilitiesarray of ProjectFacility (object)

apiOperationapiOperation (any)

Response

202400

Project Staff request has been accepted.

Body

*/*

BulkAcceptedResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('/project/facility/v1/bulk/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

202

{}

Update Project Facilities

Update Project Facilities

POST/project/facility/v1/_update

Body

application/json

Capture linkage of Project and facility.

ProjectFacility*ProjectFacility (object)

This object defines the mapping of a facility to a project.

Response

202400

Project Facility request has been accepted

Body

*/*

ProjectFacility*ProjectFacility (object)

This object defines the mapping of a facility to a project.

Request

JavaScriptCurlPython

const response = await fetch('/project/facility/v1/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ProjectFacility": {
        "facilityId": "text",
        "projectId": "text"
      }
    }),
});
const data = await response.json();

Response

202

{
  "ProjectFacility": {
    "facilityId": "text",
    "projectId": "text"
  }
}

Update Project Facilities

Update Project Facilities

POST/project/facility/v1/bulk/_update

Body

application/json

Capture linkage of Project and facility.

ProjectFacilitiesarray of ProjectFacility (object)

apiOperationapiOperation (any)

Response

202400

Project Facility request has been accepted

Body

*/*

BulkAcceptedResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('/project/facility/v1/bulk/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

202

{}

Soft delete Project Facility

Soft delete Project Facility

POST/project/facility/v1/_delete

Body

application/json

Capture linkage of Project and facility.

ProjectFacility*ProjectFacility (object)

This object defines the mapping of a facility to a project.

Response

202400

Project Facility delete request has been accepted

Body

*/*

ProjectFacility*ProjectFacility (object)

This object defines the mapping of a facility to a project.

Request

JavaScriptCurlPython

const response = await fetch('/project/facility/v1/_delete', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ProjectFacility": {
        "facilityId": "text",
        "projectId": "text"
      }
    }),
});
const data = await response.json();

Response

202

{
  "ProjectFacility": {
    "facilityId": "text",
    "projectId": "text"
  }
}

Soft delete Project Facilities in bulk

Soft delete Project Facilities in bulk

POST/project/facility/v1/bulk/_delete

Body

application/json

Capture linkage of Project and facility.

ProjectFacilitiesarray of ProjectFacility (object)

apiOperationapiOperation (any)

Response

202400

Project Facility delete request has been accepted

Body

*/*

BulkAcceptedResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('/project/facility/v1/bulk/_delete', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

202

{}

Search Project Facilities

Search Project Facilities

POST/project/facility/v1/_search

Query parameters

Body

application/json

Capture linkage of Project and facility.

ProjectFacility*ProjectFacilitySearch (object)

This object defines the mapping of a facility to a project.

Response

200400

Project Facilities

Body

*/*

ProjectFacilitiesarray of ProjectFacility (object)

Request

JavaScriptCurlPython

const response = await fetch('/project/facility/v1/_search?limit=0&offset=0&tenantId=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ProjectFacility": {}
    }),
});
const data = await response.json();

Response

200

{
  "ProjectFacilities": [
    {
      "facilityId": "text",
      "projectId": "text"
    }
  ]
}

Link Resources to Project

Link Resources to Project

POST/project/resource/v1/_create

Body

application/json

Capture linkage of Project and resources.

ProjectResource*ProjectResource (object)

This object defines the mapping of a resource to a project.

Response

202400

Project Resource request has been accepted.

Body

*/*

ProjectResource*ProjectResource (object)

This object defines the mapping of a resource to a project.

Request

JavaScriptCurlPython

const response = await fetch('/project/resource/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ProjectResource": {
        "projectId": "text"
      }
    }),
});
const data = await response.json();

Response

202

{
  "ProjectResource": {
    "projectId": "text",
    "resource": {
      "productVariantId": "text",
      "type": "text",
      "isBaseUnitVariant": false
    },
    "startDate": 0,
    "endDate": 0
  }
}

Link Resources to Project in bulk

Link Resources to Project

POST/project/resource/v1/bulk/_create

Body

application/json

Capture linkage of Project and resources.

ProjectResourcesarray of ProjectResource (object)

Response

202400

Project Resource request has been accepted.

Body

*/*

BulkAcceptedResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('/project/resource/v1/bulk/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

202

{}

Update Project Resource linkage

Update Project Resource linkage

POST/project/resource/v1/_update

Body

application/json

Capture linkage of Project and Resource.

ProjectResource*ProjectResource (object)

This object defines the mapping of a resource to a project.

Response

202400

Project Resource request has been accepted

Body

*/*

ProjectResource*ProjectResource (object)

This object defines the mapping of a resource to a project.

Request

JavaScriptCurlPython

const response = await fetch('/project/resource/v1/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ProjectResource": {
        "projectId": "text"
      }
    }),
});
const data = await response.json();

Response

202

{
  "ProjectResource": {
    "projectId": "text",
    "resource": {
      "productVariantId": "text",
      "type": "text",
      "isBaseUnitVariant": false
    },
    "startDate": 0,
    "endDate": 0
  }
}

Update Project Resource linkage in bulk

Update Project Resource linkage in bulk

POST/project/resource/v1/bulk/_update

Body

application/json

Capture linkage of Project and Resource.

ProjectResourcesarray of ProjectResource (object)

Response

202400

Project Resource request has been accepted

Body

*/*

BulkAcceptedResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('/project/resource/v1/bulk/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

202

{}

Delete Project Resource linkage

Delete Project Resource linkage

POST/project/resource/v1/_delete

Body

application/json

Delete linkage of Project and Resource.

ProjectResource*ProjectResource (object)

This object defines the mapping of a resource to a project.

Response

202400

Project Resource deletion request has been accepted

Body

*/*

ProjectResource*ProjectResource (object)

This object defines the mapping of a resource to a project.

Request

JavaScriptCurlPython

const response = await fetch('/project/resource/v1/_delete', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ProjectResource": {
        "projectId": "text"
      }
    }),
});
const data = await response.json();

Response

202

{
  "ProjectResource": {
    "projectId": "text",
    "resource": {
      "productVariantId": "text",
      "type": "text",
      "isBaseUnitVariant": false
    },
    "startDate": 0,
    "endDate": 0
  }
}

Delete Project Resource linkage in bulk

Delete Project Resource linkage in bulk

POST/project/resource/v1/bulk/_delete

Body

application/json

Delete linkage of Project and Resource.

ProjectResourcesarray of ProjectResource (object)

Response

202400

Project Resource deletion request has been accepted

Body

*/*

BulkAcceptedResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('/project/resource/v1/bulk/_delete', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

202

{}

Search Project Resources

Search Project Resources

POST/project/resource/v1/_search

Query parameters

Body

application/json

Search linkage of Project and resource.

ProjectResource*ProjectResourceSearch (object)

This object defines the mapping of a resource to a project.

Response

200400

Project Resources

Body

*/*

ProjectResourcesarray of ProjectResource (object)

Request

JavaScriptCurlPython

const response = await fetch('/project/resource/v1/_search?limit=0&offset=0&tenantId=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ProjectResource": {}
    }),
});
const data = await response.json();

Response

200

{
  "ProjectResources": [
    {
      "projectId": "text",
      "resource": {
        "productVariantId": "text",
        "type": "text",
        "isBaseUnitVariant": false
      },
      "startDate": 0,
      "endDate": 0
    }
  ]
}