Project

Project Management Service APIs

Facilitate the management of projects.

Create a new Project

Create a new Project

post

/project/v1/_create

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

apiOperationstring · enum

Specify the type of operation being performed i.e. CREATE, UPDATE or DELETE

Example: CREATE

Options: CREATE, UPDATE, DELETE

Projectsobject[]

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/project/v1/_create' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"apiOperation":"CREATE","Projects":[{"tenantId":"tenantA","projectNumber":"PR/2022-23/010","ancestors":{"tenantId":"tenantA","projectNumber":"PR/2022-23/010","ancestors":{"tenantId":"tenantA","projectNumber":"PR/2022-23/010","ancestors":{"tenantId":"tenantA","projectNumber":"PR/2022-23/010","ancestors":"[Circular Reference]","address":"[Circular Reference]","isTaskEnabled":false,"additionalDetails":{},"auditDetails":{},"targets":[{"beneficiaryType":"HOUSEHOLD","baseline":1,"target":1,"auditDetails":{}}]},"address":{"tenantId":"tenantA","locality":"[Circular Reference]"},"isTaskEnabled":false,"additionalDetails":{},"auditDetails":{},"targets":[{"beneficiaryType":"HOUSEHOLD","baseline":1,"target":1,"auditDetails":{}}]},"address":{"tenantId":"tenantA","locality":"[Circular Reference]"},"isTaskEnabled":false,"additionalDetails":{},"auditDetails":{},"targets":[{"beneficiaryType":"HOUSEHOLD","baseline":1,"target":1,"auditDetails":{}}]},"address":{"tenantId":"tenantA","locality":"[Circular Reference]"},"isTaskEnabled":false,"additionalDetails":{},"auditDetails":{},"targets":[{"beneficiaryType":"HOUSEHOLD","baseline":1,"target":1,"auditDetails":{}}]}]}'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "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",
      "ancestors": {
        "tenantId": "tenantA",
        "projectNumber": "PR/2022-23/010",
        "ancestors": {
          "tenantId": "tenantA",
          "projectNumber": "PR/2022-23/010",
          "ancestors": {
            "tenantId": "tenantA",
            "projectNumber": "PR/2022-23/010",
            "ancestors": "[Circular Reference]",
            "address": "[Circular Reference]",
            "isTaskEnabled": false,
            "additionalDetails": {},
            "auditDetails": {},
            "targets": [
              {
                "beneficiaryType": "HOUSEHOLD",
                "baseline": 1,
                "target": 1,
                "auditDetails": {}
              }
            ]
          },
          "address": {
            "tenantId": "tenantA",
            "locality": "[Circular Reference]"
          },
          "isTaskEnabled": false,
          "additionalDetails": {},
          "auditDetails": {},
          "targets": [
            {
              "beneficiaryType": "HOUSEHOLD",
              "baseline": 1,
              "target": 1,
              "auditDetails": {}
            }
          ]
        },
        "address": {
          "tenantId": "tenantA",
          "locality": "[Circular Reference]"
        },
        "isTaskEnabled": false,
        "additionalDetails": {},
        "auditDetails": {},
        "targets": [
          {
            "beneficiaryType": "HOUSEHOLD",
            "baseline": 1,
            "target": 1,
            "auditDetails": {}
          }
        ]
      },
      "address": {
        "tenantId": "tenantA",
        "locality": "[Circular Reference]"
      },
      "startDate": 1,
      "endDate": 1,
      "isTaskEnabled": false,
      "parent": "text",
      "additionalDetails": {},
      "isDeleted": true,
      "rowVersion": 1,
      "auditDetails": {},
      "targets": [
        {
          "beneficiaryType": "HOUSEHOLD",
          "baseline": 1,
          "target": 1,
          "auditDetails": {}
        }
      ]
    }
  ]
}

Project request accepted for creation.

Update the details of a existing Project

Update the details of a existing Project

post

/project/v1/_update

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

apiOperationstring · enum

Specify the type of operation being performed i.e. CREATE, UPDATE or DELETE

Example: CREATE

Options: CREATE, UPDATE, DELETE

Projectsobject[]

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/project/v1/_update' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"apiOperation":"CREATE","Projects":[{"tenantId":"tenantA","projectNumber":"PR/2022-23/010","ancestors":{"tenantId":"tenantA","projectNumber":"PR/2022-23/010","ancestors":{"tenantId":"tenantA","projectNumber":"PR/2022-23/010","ancestors":{"tenantId":"tenantA","projectNumber":"PR/2022-23/010","ancestors":"[Circular Reference]","address":"[Circular Reference]","isTaskEnabled":false,"additionalDetails":{},"auditDetails":{},"targets":[{"beneficiaryType":"HOUSEHOLD","baseline":1,"target":1,"auditDetails":{}}]},"address":{"tenantId":"tenantA","locality":"[Circular Reference]"},"isTaskEnabled":false,"additionalDetails":{},"auditDetails":{},"targets":[{"beneficiaryType":"HOUSEHOLD","baseline":1,"target":1,"auditDetails":{}}]},"address":{"tenantId":"tenantA","locality":"[Circular Reference]"},"isTaskEnabled":false,"additionalDetails":{},"auditDetails":{},"targets":[{"beneficiaryType":"HOUSEHOLD","baseline":1,"target":1,"auditDetails":{}}]},"address":{"tenantId":"tenantA","locality":"[Circular Reference]"},"isTaskEnabled":false,"additionalDetails":{},"auditDetails":{},"targets":[{"beneficiaryType":"HOUSEHOLD","baseline":1,"target":1,"auditDetails":{}}]}]}'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "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",
      "ancestors": {
        "tenantId": "tenantA",
        "projectNumber": "PR/2022-23/010",
        "ancestors": {
          "tenantId": "tenantA",
          "projectNumber": "PR/2022-23/010",
          "ancestors": {
            "tenantId": "tenantA",
            "projectNumber": "PR/2022-23/010",
            "ancestors": "[Circular Reference]",
            "address": "[Circular Reference]",
            "isTaskEnabled": false,
            "additionalDetails": {},
            "auditDetails": {},
            "targets": [
              {
                "beneficiaryType": "HOUSEHOLD",
                "baseline": 1,
                "target": 1,
                "auditDetails": {}
              }
            ]
          },
          "address": {
            "tenantId": "tenantA",
            "locality": "[Circular Reference]"
          },
          "isTaskEnabled": false,
          "additionalDetails": {},
          "auditDetails": {},
          "targets": [
            {
              "beneficiaryType": "HOUSEHOLD",
              "baseline": 1,
              "target": 1,
              "auditDetails": {}
            }
          ]
        },
        "address": {
          "tenantId": "tenantA",
          "locality": "[Circular Reference]"
        },
        "isTaskEnabled": false,
        "additionalDetails": {},
        "auditDetails": {},
        "targets": [
          {
            "beneficiaryType": "HOUSEHOLD",
            "baseline": 1,
            "target": 1,
            "auditDetails": {}
          }
        ]
      },
      "address": {
        "tenantId": "tenantA",
        "locality": "[Circular Reference]"
      },
      "startDate": 1,
      "endDate": 1,
      "isTaskEnabled": false,
      "parent": "text",
      "additionalDetails": {},
      "isDeleted": true,
      "rowVersion": 1,
      "auditDetails": {},
      "targets": [
        {
          "beneficiaryType": "HOUSEHOLD",
          "baseline": 1,
          "target": 1,
          "auditDetails": {}
        }
      ]
    }
  ]
}

Employee request accepted for creation.

Search for existing project

Search for existing project

post

/project/v1/_search

Query parameters

limitinteger · max: 1000required

Pagination - limit records in response

offsetintegerrequired

Pagination - offset from which records should be returned in response

tenantIdstring · varcharrequired

Unique id for a tenant.

lastChangedSinceinteger · int64

epoch of the time since when the changes on the object should be picked up. Search results from this parameter should include both newly created objects since this time as well as any modified objects since this time. This criterion is included to help polling clients to get the changes in system since a last time they synchronized with the platform.

includeDeletedboolean

Used in search APIs to specify if (soft) deleted records should be included in search results.

includeAncestorsboolean

Used in project search API to specify if response should include project elements that are in the preceding hierarchy of matched projects.

includeDescendantsboolean

Used in project search API to specify if response should include project elements that are in the following hierarchy of matched projects.

createdFrominteger · int64

Used in project search API to limit the search results to only those projects whose creation date is after the specified 'createdFrom' date.

createdTointeger · int64

Used in project search API to limit the search results to only those projects whose creation date is before the specified 'createdTo' date.

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

apiOperationstring · enum

Specify the type of operation being performed i.e. CREATE, UPDATE or DELETE

Example: CREATE

Options: CREATE, UPDATE, DELETE

Projectsobject[]

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/project/v1/_search?limit=1&offset=1&tenantId=text' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"apiOperation":"CREATE","Projects":[{"tenantId":"tenantA","projectNumber":"PR/2022-23/010","ancestors":{"tenantId":"tenantA","projectNumber":"PR/2022-23/010","ancestors":{"tenantId":"tenantA","projectNumber":"PR/2022-23/010","ancestors":{"tenantId":"tenantA","projectNumber":"PR/2022-23/010","ancestors":"[Circular Reference]","address":"[Circular Reference]","isTaskEnabled":false,"additionalDetails":{},"auditDetails":{},"targets":[{"beneficiaryType":"HOUSEHOLD","baseline":1,"target":1,"auditDetails":{}}]},"address":{"tenantId":"tenantA","locality":"[Circular Reference]"},"isTaskEnabled":false,"additionalDetails":{},"auditDetails":{},"targets":[{"beneficiaryType":"HOUSEHOLD","baseline":1,"target":1,"auditDetails":{}}]},"address":{"tenantId":"tenantA","locality":"[Circular Reference]"},"isTaskEnabled":false,"additionalDetails":{},"auditDetails":{},"targets":[{"beneficiaryType":"HOUSEHOLD","baseline":1,"target":1,"auditDetails":{}}]},"address":{"tenantId":"tenantA","locality":"[Circular Reference]"},"isTaskEnabled":false,"additionalDetails":{},"auditDetails":{},"targets":[{"beneficiaryType":"HOUSEHOLD","baseline":1,"target":1,"auditDetails":{}}]}]}'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "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",
      "ancestors": {
        "tenantId": "tenantA",
        "projectNumber": "PR/2022-23/010",
        "ancestors": {
          "tenantId": "tenantA",
          "projectNumber": "PR/2022-23/010",
          "ancestors": {
            "tenantId": "tenantA",
            "projectNumber": "PR/2022-23/010",
            "ancestors": "[Circular Reference]",
            "address": "[Circular Reference]",
            "isTaskEnabled": false,
            "additionalDetails": {},
            "auditDetails": {},
            "targets": [
              {
                "beneficiaryType": "HOUSEHOLD",
                "baseline": 1,
                "target": 1,
                "auditDetails": {}
              }
            ]
          },
          "address": {
            "tenantId": "tenantA",
            "locality": "[Circular Reference]"
          },
          "isTaskEnabled": false,
          "additionalDetails": {},
          "auditDetails": {},
          "targets": [
            {
              "beneficiaryType": "HOUSEHOLD",
              "baseline": 1,
              "target": 1,
              "auditDetails": {}
            }
          ]
        },
        "address": {
          "tenantId": "tenantA",
          "locality": "[Circular Reference]"
        },
        "isTaskEnabled": false,
        "additionalDetails": {},
        "auditDetails": {},
        "targets": [
          {
            "beneficiaryType": "HOUSEHOLD",
            "baseline": 1,
            "target": 1,
            "auditDetails": {}
          }
        ]
      },
      "address": {
        "tenantId": "tenantA",
        "locality": "[Circular Reference]"
      },
      "startDate": 1,
      "endDate": 1,
      "isTaskEnabled": false,
      "parent": "text",
      "additionalDetails": {},
      "isDeleted": true,
      "rowVersion": 1,
      "auditDetails": {},
      "targets": [
        {
          "beneficiaryType": "HOUSEHOLD",
          "baseline": 1,
          "target": 1,
          "auditDetails": {}
        }
      ]
    }
  ]
}

Projects.

Add beneficiary for project

Add beneficiary for project

post

/project/beneficiary/v1/_create

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

ProjectBeneficiaryobject

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

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/project/beneficiary/v1/_create' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"ProjectBeneficiary":{"tenantId":"tenantA","projectId":"text","beneficiaryId":"text","dateOfRegistration":1663218161,"additionalFields":{"schema":"HOUSEHOLD","version":2,"fields":[{"key":"height","value":180}]},"auditDetails":{}}}'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "ProjectBeneficiary": {
    "id": "text",
    "clientReferenceId": "text",
    "tenantId": "tenantA",
    "projectId": "text",
    "beneficiaryId": "text",
    "beneficiaryClientReferenceId": "text",
    "dateOfRegistration": 1663218161,
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    },
    "isDeleted": true,
    "rowVersion": 1,
    "auditDetails": {}
  }
}

add beneficiary request has been accepted for creation.

Add beneficiaries for project

Add beneficiaries for project

post

/project/beneficiary/v1/bulk/_create

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

ProjectBeneficiariesobject[]

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/project/beneficiary/v1/bulk/_create' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"ProjectBeneficiaries":[{"tenantId":"tenantA","projectId":"text","beneficiaryId":"text","dateOfRegistration":1663218161,"additionalFields":{"schema":"HOUSEHOLD","version":2,"fields":[{"key":"height","value":180}]},"auditDetails":{}}]}'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  }
}

add beneficiary request has been accepted for creation.

Update beneficiary registration for project

Update beneficiary registration for project

post

/project/beneficiary/v1/_update

Query parameters

echoResourceboolean · default: true

Client can specify if the resource in request body needs to be sent back in the response. This is being used to limit amount of data that needs to flow back from the server to the client in low bandwidth scenarios. Server will always send the server generated id for validated requests.

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

ProjectBeneficiaryobject

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

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/project/beneficiary/v1/_update' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"ProjectBeneficiary":{"tenantId":"tenantA","projectId":"text","beneficiaryId":"text","dateOfRegistration":1663218161,"additionalFields":{"schema":"HOUSEHOLD","version":2,"fields":[{"key":"height","value":180}]},"auditDetails":{}}}'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "ProjectBeneficiary": {
    "id": "text",
    "clientReferenceId": "text",
    "tenantId": "tenantA",
    "projectId": "text",
    "beneficiaryId": "text",
    "beneficiaryClientReferenceId": "text",
    "dateOfRegistration": 1663218161,
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    },
    "isDeleted": true,
    "rowVersion": 1,
    "auditDetails": {}
  }
}

Project Beneficiary request has been accepted.

Update beneficiaries registration for project

Update beneficiaries registration for project

post

/project/beneficiary/v1/bulk/_update

Query parameters

echoResourceboolean · default: true

Client can specify if the resource in request body needs to be sent back in the response. This is being used to limit amount of data that needs to flow back from the server to the client in low bandwidth scenarios. Server will always send the server generated id for validated requests.

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

ProjectBeneficiariesobject[]

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/project/beneficiary/v1/bulk/_update' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"ProjectBeneficiaries":[{"tenantId":"tenantA","projectId":"text","beneficiaryId":"text","dateOfRegistration":1663218161,"additionalFields":{"schema":"HOUSEHOLD","version":2,"fields":[{"key":"height","value":180}]},"auditDetails":{}}]}'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  }
}

Project Beneficiary request has been accepted.

Soft delete beneficiary registration for project

Soft delete registration for project

post

/project/beneficiary/v1/_delete

Query parameters

echoResourceboolean · default: true

Client can specify if the resource in request body needs to be sent back in the response. This is being used to limit amount of data that needs to flow back from the server to the client in low bandwidth scenarios. Server will always send the server generated id for validated requests.

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

ProjectBeneficiaryobject

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

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/project/beneficiary/v1/_delete' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"ProjectBeneficiary":{"tenantId":"tenantA","projectId":"text","beneficiaryId":"text","dateOfRegistration":1663218161,"additionalFields":{"schema":"HOUSEHOLD","version":2,"fields":[{"key":"height","value":180}]},"auditDetails":{}}}'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "ProjectBeneficiary": {
    "id": "text",
    "clientReferenceId": "text",
    "tenantId": "tenantA",
    "projectId": "text",
    "beneficiaryId": "text",
    "beneficiaryClientReferenceId": "text",
    "dateOfRegistration": 1663218161,
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    },
    "isDeleted": true,
    "rowVersion": 1,
    "auditDetails": {}
  }
}

Project Beneficiary request has been accepted.

Update beneficiaries registration for project

Update beneficiaries registration for project

post

/project/beneficiary/v1/bulk/_delete

Query parameters

echoResourceboolean · default: true

Client can specify if the resource in request body needs to be sent back in the response. This is being used to limit amount of data that needs to flow back from the server to the client in low bandwidth scenarios. Server will always send the server generated id for validated requests.

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

ProjectBeneficiariesobject[]

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/project/beneficiary/v1/bulk/_delete' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"ProjectBeneficiaries":[{"tenantId":"tenantA","projectId":"text","beneficiaryId":"text","dateOfRegistration":1663218161,"additionalFields":{"schema":"HOUSEHOLD","version":2,"fields":[{"key":"height","value":180}]},"auditDetails":{}}]}'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  }
}

Project Beneficiary request has been accepted.

Search beneficiary registration for Project

Search beneficiary registration for Project

post

/project/beneficiary/v1/_search

Query parameters

limitinteger · max: 1000required

Pagination - limit records in response

offsetintegerrequired

Pagination - offset from which records should be returned in response

tenantIdstring · varcharrequired

Unique id for a tenant.

lastChangedSinceinteger · int64

epoch of the time since when the changes on the object should be picked up. Search results from this parameter should include both newly created objects since this time as well as any modified objects since this time. This criterion is included to help polling clients to get the changes in system since a last time they synchronized with the platform.

includeDeletedboolean

Used in search APIs to specify if (soft) deleted records should be included in search results.

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

ProjectBeneficiaryobject

Search model for project beneficiary.

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/project/beneficiary/v1/_search?limit=1&offset=1&tenantId=text' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"ProjectBeneficiary":{"id":[null],"clientReferenceId":[null],"dateOfRegistration":1663218161}}'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "ProjectBeneficiaries": [
    {
      "id": "text",
      "clientReferenceId": "text",
      "tenantId": "tenantA",
      "projectId": "text",
      "beneficiaryId": "text",
      "beneficiaryClientReferenceId": "text",
      "dateOfRegistration": 1663218161,
      "additionalFields": {
        "schema": "HOUSEHOLD",
        "version": 2,
        "fields": [
          {
            "key": "height",
            "value": 180
          }
        ]
      },
      "isDeleted": true,
      "rowVersion": 1,
      "auditDetails": {}
    }
  ]
}

Project Beneficaries.

Create task for the project

Create task for the project

post

/project/task/v1/_create

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Taskobjectrequired

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/project/task/v1/_create' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"Task":{"tenantId":"tenantA","projectId":"text","projectBeneficiaryId":"R-ID-1","projectBeneficiaryClientReferenceId":"R-ID-1","createdBy":"UUID","createdDate":1663218161,"address":{"tenantId":"tenantA","locality":{"code":"text","name":"text","children":[{"code":"text","name":"text","children":"[Circular Reference]"}]}},"additionalFields":{"schema":"HOUSEHOLD","version":2,"fields":[{"key":"height","value":180}]},"auditDetails":{},"status":"DELIVERED","resources":[{"tenantId":"tenantA","productVariantId":"ID-1","quantity":1,"isDelivered":true,"auditDetails":{}}]}}'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Task": {
    "id": "text",
    "clientReferenceId": "text",
    "tenantId": "tenantA",
    "projectId": "text",
    "projectBeneficiaryId": "R-ID-1",
    "projectBeneficiaryClientReferenceId": "R-ID-1",
    "plannedStartDate": 1,
    "plannedEndDate": 1,
    "actualStartDate": 1,
    "actualEndDate": 1,
    "createdBy": "UUID",
    "createdDate": 1663218161,
    "address": {
      "tenantId": "tenantA",
      "locality": {
        "code": "text",
        "name": "text",
        "children": [
          {
            "code": "text",
            "name": "text",
            "children": "[Circular Reference]"
          }
        ]
      }
    },
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    },
    "isDeleted": true,
    "rowVersion": 1,
    "auditDetails": {},
    "status": "DELIVERED",
    "resources": [
      {
        "tenantId": "tenantA",
        "productVariantId": "ID-1",
        "quantity": 1,
        "isDelivered": true,
        "auditDetails": {}
      }
    ]
  }
}

Create task request has been accepted for creation.

Create tasks for the project in bulk

Create tasks for the project in bulk

post

/project/task/v1/bulk/_create

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Tasksobject[]

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/project/task/v1/bulk/_create' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"Tasks":[{"tenantId":"tenantA","projectId":"text","projectBeneficiaryId":"R-ID-1","projectBeneficiaryClientReferenceId":"R-ID-1","createdBy":"UUID","createdDate":1663218161,"address":{"tenantId":"tenantA","locality":{"code":"text","name":"text","children":[{"code":"text","name":"text","children":"[Circular Reference]"}]}},"additionalFields":{"schema":"HOUSEHOLD","version":2,"fields":[{"key":"height","value":180}]},"auditDetails":{},"status":"DELIVERED","resources":[{"tenantId":"tenantA","productVariantId":"ID-1","quantity":1,"isDelivered":true,"auditDetails":{}}]}]}'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  }
}

Create task request has been accepted for creation.

Task Request

Task Request

post

/project/task/v1/_update

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Taskobjectrequired

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/project/task/v1/_update' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"Task":{"tenantId":"tenantA","projectId":"text","projectBeneficiaryId":"R-ID-1","projectBeneficiaryClientReferenceId":"R-ID-1","createdBy":"UUID","createdDate":1663218161,"address":{"tenantId":"tenantA","locality":{"code":"text","name":"text","children":[{"code":"text","name":"text","children":"[Circular Reference]"}]}},"additionalFields":{"schema":"HOUSEHOLD","version":2,"fields":[{"key":"height","value":180}]},"auditDetails":{},"status":"DELIVERED","resources":[{"tenantId":"tenantA","productVariantId":"ID-1","quantity":1,"isDelivered":true,"auditDetails":{}}]}}'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Task": {
    "id": "text",
    "clientReferenceId": "text",
    "tenantId": "tenantA",
    "projectId": "text",
    "projectBeneficiaryId": "R-ID-1",
    "projectBeneficiaryClientReferenceId": "R-ID-1",
    "plannedStartDate": 1,
    "plannedEndDate": 1,
    "actualStartDate": 1,
    "actualEndDate": 1,
    "createdBy": "UUID",
    "createdDate": 1663218161,
    "address": {
      "tenantId": "tenantA",
      "locality": {
        "code": "text",
        "name": "text",
        "children": [
          {
            "code": "text",
            "name": "text",
            "children": "[Circular Reference]"
          }
        ]
      }
    },
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    },
    "isDeleted": true,
    "rowVersion": 1,
    "auditDetails": {},
    "status": "DELIVERED",
    "resources": [
      {
        "tenantId": "tenantA",
        "productVariantId": "ID-1",
        "quantity": 1,
        "isDelivered": true,
        "auditDetails": {}
      }
    ]
  }
}

update task request has been accepted for update.

Task Request in bulk for a project

Task Request in bulk for a project

post

/project/task/v1/bulk/_update

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Tasksobject[]

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/project/task/v1/bulk/_update' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"Tasks":[{"tenantId":"tenantA","projectId":"text","projectBeneficiaryId":"R-ID-1","projectBeneficiaryClientReferenceId":"R-ID-1","createdBy":"UUID","createdDate":1663218161,"address":{"tenantId":"tenantA","locality":{"code":"text","name":"text","children":[{"code":"text","name":"text","children":"[Circular Reference]"}]}},"additionalFields":{"schema":"HOUSEHOLD","version":2,"fields":[{"key":"height","value":180}]},"auditDetails":{},"status":"DELIVERED","resources":[{"tenantId":"tenantA","productVariantId":"ID-1","quantity":1,"isDelivered":true,"auditDetails":{}}]}]}'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  }
}

update tasks bulk request has been accepted for update.

Soft delete Task for a project

Soft delete Task for a project

post

/project/task/v1/_delete

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Taskobjectrequired

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/project/task/v1/_delete' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"Task":{"tenantId":"tenantA","projectId":"text","projectBeneficiaryId":"R-ID-1","projectBeneficiaryClientReferenceId":"R-ID-1","createdBy":"UUID","createdDate":1663218161,"address":{"tenantId":"tenantA","locality":{"code":"text","name":"text","children":[{"code":"text","name":"text","children":"[Circular Reference]"}]}},"additionalFields":{"schema":"HOUSEHOLD","version":2,"fields":[{"key":"height","value":180}]},"auditDetails":{},"status":"DELIVERED","resources":[{"tenantId":"tenantA","productVariantId":"ID-1","quantity":1,"isDelivered":true,"auditDetails":{}}]}}'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Task": {
    "id": "text",
    "clientReferenceId": "text",
    "tenantId": "tenantA",
    "projectId": "text",
    "projectBeneficiaryId": "R-ID-1",
    "projectBeneficiaryClientReferenceId": "R-ID-1",
    "plannedStartDate": 1,
    "plannedEndDate": 1,
    "actualStartDate": 1,
    "actualEndDate": 1,
    "createdBy": "UUID",
    "createdDate": 1663218161,
    "address": {
      "tenantId": "tenantA",
      "locality": {
        "code": "text",
        "name": "text",
        "children": [
          {
            "code": "text",
            "name": "text",
            "children": "[Circular Reference]"
          }
        ]
      }
    },
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    },
    "isDeleted": true,
    "rowVersion": 1,
    "auditDetails": {},
    "status": "DELIVERED",
    "resources": [
      {
        "tenantId": "tenantA",
        "productVariantId": "ID-1",
        "quantity": 1,
        "isDelivered": true,
        "auditDetails": {}
      }
    ]
  }
}

delete task request has been accepted for deletion.

Soft delete Tasks for a project

Soft delete Tasks for a project

post

/project/task/v1/bulk/_delete

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Tasksobject[]

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/project/task/v1/bulk/_delete' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"Tasks":[{"tenantId":"tenantA","projectId":"text","projectBeneficiaryId":"R-ID-1","projectBeneficiaryClientReferenceId":"R-ID-1","createdBy":"UUID","createdDate":1663218161,"address":{"tenantId":"tenantA","locality":{"code":"text","name":"text","children":[{"code":"text","name":"text","children":"[Circular Reference]"}]}},"additionalFields":{"schema":"HOUSEHOLD","version":2,"fields":[{"key":"height","value":180}]},"auditDetails":{},"status":"DELIVERED","resources":[{"tenantId":"tenantA","productVariantId":"ID-1","quantity":1,"isDelivered":true,"auditDetails":{}}]}]}'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  }
}

delete bulk task request has been accepted for deletion.

Search task for Project

Search task for Project

post

/project/task/v1/_search

Query parameters

limitinteger · max: 1000required

Pagination - limit records in response

offsetintegerrequired

Pagination - offset from which records should be returned in response

tenantIdstring · varcharrequired

Unique id for a tenant.

lastChangedSinceinteger · int64

epoch of the time since when the changes on the object should be picked up. Search results from this parameter should include both newly created objects since this time as well as any modified objects since this time. This criterion is included to help polling clients to get the changes in system since a last time they synchronized with the platform.

includeDeletedboolean

Used in search APIs to specify if (soft) deleted records should be included in search results.

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Taskobjectrequired

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/project/task/v1/_search?limit=1&offset=1&tenantId=text' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"Task":{"id":[null],"clientReferenceId":[null],"projectBeneficiaryId":"R-ID-1","createdBy":"UUID","status":"DELIVERED"}}'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Tasks": [
    {
      "id": "text",
      "clientReferenceId": "text",
      "tenantId": "tenantA",
      "projectId": "text",
      "projectBeneficiaryId": "R-ID-1",
      "projectBeneficiaryClientReferenceId": "R-ID-1",
      "plannedStartDate": 1,
      "plannedEndDate": 1,
      "actualStartDate": 1,
      "actualEndDate": 1,
      "createdBy": "UUID",
      "createdDate": 1663218161,
      "address": {
        "tenantId": "tenantA",
        "locality": {
          "code": "text",
          "name": "text",
          "children": [
            {
              "code": "text",
              "name": "text",
              "children": "[Circular Reference]"
            }
          ]
        }
      },
      "additionalFields": {
        "schema": "HOUSEHOLD",
        "version": 2,
        "fields": [
          {
            "key": "height",
            "value": 180
          }
        ]
      },
      "isDeleted": true,
      "rowVersion": 1,
      "auditDetails": {},
      "status": "DELIVERED",
      "resources": [
        {
          "tenantId": "tenantA",
          "productVariantId": "ID-1",
          "quantity": 1,
          "isDelivered": true,
          "auditDetails": {}
        }
      ]
    }
  ]
}

Project Tasks.

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

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

ProjectStaffobjectrequired

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

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/project/staff/v1/_create' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"ProjectStaff":{"tenantId":"tenantA","userId":"text","projectId":"text","auditDetails":{}}}'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "ProjectStaff": {
    "id": "text",
    "tenantId": "tenantA",
    "userId": "text",
    "projectId": "text",
    "startDate": 1,
    "endDate": 1,
    "channel": "text",
    "isDeleted": true,
    "rowVersion": 1,
    "auditDetails": {}
  }
}

Project Staff request has been accepted.

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

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

ProjectStaffobject[]required

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/project/staff/v1/bulk/_create' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"ProjectStaff":[{"tenantId":"tenantA","userId":"text","projectId":"text","auditDetails":{}}]}'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  }
}

Project Staff request has been accepted.

Update Project Staff users

Update Project Staff users

post

/project/staff/v1/_update

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

ProjectStaffobjectrequired

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

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/project/staff/v1/_update' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"ProjectStaff":{"tenantId":"tenantA","userId":"text","projectId":"text","auditDetails":{}}}'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "ProjectStaff": {
    "id": "text",
    "tenantId": "tenantA",
    "userId": "text",
    "projectId": "text",
    "startDate": 1,
    "endDate": 1,
    "channel": "text",
    "isDeleted": true,
    "rowVersion": 1,
    "auditDetails": {}
  }
}

Project Staff request has been accepted for updation.

Update Project Staff users using bulk payload

Update Project Staff users using bulk payload

post

/project/staff/v1/bulk/_update

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

ProjectStaffobject[]required

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/project/staff/v1/bulk/_update' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"ProjectStaff":[{"tenantId":"tenantA","userId":"text","projectId":"text","auditDetails":{}}]}'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  }
}

Project Staff bulk request has been accepted for update.

Soft delete linkage of Project Staff users with project

Soft delete linkage of Project Staff users with project

post

/project/staff/v1/_delete

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

ProjectStaffobjectrequired

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

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/project/staff/v1/_delete' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"ProjectStaff":{"tenantId":"tenantA","userId":"text","projectId":"text","auditDetails":{}}}'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "ProjectStaff": {
    "id": "text",
    "tenantId": "tenantA",
    "userId": "text",
    "projectId": "text",
    "startDate": 1,
    "endDate": 1,
    "channel": "text",
    "isDeleted": true,
    "rowVersion": 1,
    "auditDetails": {}
  }
}

Project Staff request has been accepted for deletion.

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

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

ProjectStaffobject[]required

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/project/staff/v1/bulk/_delete' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"ProjectStaff":[{"tenantId":"tenantA","userId":"text","projectId":"text","auditDetails":{}}]}'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  }
}

Project Staff request has been accepted for deletion.

Search Project Staff users

Search Project Staff users

post

/project/staff/v1/_search

Query parameters

limitinteger · max: 1000required

Pagination - limit records in response

offsetintegerrequired

Pagination - offset from which records should be returned in response

tenantIdstring · varcharrequired

Unique id for a tenant.

lastChangedSinceinteger · int64

epoch of the time since when the changes on the object should be picked up. Search results from this parameter should include both newly created objects since this time as well as any modified objects since this time. This criterion is included to help polling clients to get the changes in system since a last time they synchronized with the platform.

includeDeletedboolean

Used in search APIs to specify if (soft) deleted records should be included in search results.

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

ProjectStaffobjectrequired

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

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/project/staff/v1/_search?limit=1&offset=1&tenantId=text' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"ProjectStaff":{"id":[null]}}'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "ProjectStaff": [
    {
      "id": "text",
      "tenantId": "tenantA",
      "userId": "text",
      "projectId": "text",
      "startDate": 1,
      "endDate": 1,
      "channel": "text",
      "isDeleted": true,
      "rowVersion": 1,
      "auditDetails": {}
    }
  ]
}

Project Staff.

Link Facility to Project

Link Facility to Project

post

/project/facility/v1/_create

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

ProjectFacilityobjectrequired

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

apiOperationstring · enum

Specify the type of operation being performed i.e. CREATE, UPDATE or DELETE

Example: CREATE

Options: CREATE, UPDATE, DELETE

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/project/facility/v1/_create' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"ProjectFacility":{"tenantId":"tenantA","facilityId":"text","projectId":"text","auditDetails":{}},"apiOperation":"CREATE"}'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "ProjectFacility": {
    "id": "text",
    "tenantId": "tenantA",
    "facilityId": "text",
    "projectId": "text",
    "isDeleted": true,
    "rowVersion": 1,
    "auditDetails": {}
  }
}

Project Staff request has been accepted.

Link Facilities to Project

Link Facilities to Project

post

/project/facility/v1/bulk/_create

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

apiOperationstring · enum

Specify the type of operation being performed i.e. CREATE, UPDATE or DELETE

Example: CREATE

Options: CREATE, UPDATE, DELETE

ProjectFacilitiesobject[]

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/project/facility/v1/bulk/_create' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"apiOperation":"CREATE","ProjectFacilities":[{"tenantId":"tenantA","facilityId":"text","projectId":"text","auditDetails":{}}]}'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  }
}

Project Staff request has been accepted.

Update Project Facilities

Update Project Facilities

post

/project/facility/v1/_update

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

ProjectFacilityobjectrequired

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

apiOperationstring · enum

Specify the type of operation being performed i.e. CREATE, UPDATE or DELETE

Example: CREATE

Options: CREATE, UPDATE, DELETE

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/project/facility/v1/_update' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"ProjectFacility":{"tenantId":"tenantA","facilityId":"text","projectId":"text","auditDetails":{}},"apiOperation":"CREATE"}'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "ProjectFacility": {
    "id": "text",
    "tenantId": "tenantA",
    "facilityId": "text",
    "projectId": "text",
    "isDeleted": true,
    "rowVersion": 1,
    "auditDetails": {}
  }
}

Project Facility request has been accepted

Update Project Facilities

Update Project Facilities

post

/project/facility/v1/bulk/_update

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

apiOperationstring · enum

Specify the type of operation being performed i.e. CREATE, UPDATE or DELETE

Example: CREATE

Options: CREATE, UPDATE, DELETE

ProjectFacilitiesobject[]

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/project/facility/v1/bulk/_update' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"apiOperation":"CREATE","ProjectFacilities":[{"tenantId":"tenantA","facilityId":"text","projectId":"text","auditDetails":{}}]}'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  }
}

Project Facility request has been accepted

Soft delete Project Facility

Soft delete Project Facility

post

/project/facility/v1/_delete

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

ProjectFacilityobjectrequired

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

apiOperationstring · enum

Specify the type of operation being performed i.e. CREATE, UPDATE or DELETE

Example: CREATE

Options: CREATE, UPDATE, DELETE

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/project/facility/v1/_delete' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"ProjectFacility":{"tenantId":"tenantA","facilityId":"text","projectId":"text","auditDetails":{}},"apiOperation":"CREATE"}'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "ProjectFacility": {
    "id": "text",
    "tenantId": "tenantA",
    "facilityId": "text",
    "projectId": "text",
    "isDeleted": true,
    "rowVersion": 1,
    "auditDetails": {}
  }
}

Project Facility delete request has been accepted

Soft delete Project Facilities in bulk

Soft delete Project Facilities in bulk

post

/project/facility/v1/bulk/_delete

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

apiOperationstring · enum

Specify the type of operation being performed i.e. CREATE, UPDATE or DELETE

Example: CREATE

Options: CREATE, UPDATE, DELETE

ProjectFacilitiesobject[]

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/project/facility/v1/bulk/_delete' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"apiOperation":"CREATE","ProjectFacilities":[{"tenantId":"tenantA","facilityId":"text","projectId":"text","auditDetails":{}}]}'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  }
}

Project Facility delete request has been accepted

Search Project Facilities

Search Project Facilities

post

/project/facility/v1/_search

Query parameters

limitinteger · max: 1000required

Pagination - limit records in response

offsetintegerrequired

Pagination - offset from which records should be returned in response

tenantIdstring · varcharrequired

Unique id for a tenant.

lastChangedSinceinteger · int64

epoch of the time since when the changes on the object should be picked up. Search results from this parameter should include both newly created objects since this time as well as any modified objects since this time. This criterion is included to help polling clients to get the changes in system since a last time they synchronized with the platform.

includeDeletedboolean

Used in search APIs to specify if (soft) deleted records should be included in search results.

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

ProjectFacilityobjectrequired

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

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/project/facility/v1/_search?limit=1&offset=1&tenantId=text' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"ProjectFacility":{"id":[null],"facilityId":[null],"projectId":[null]}}'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "ProjectFacilities": [
    {
      "id": "text",
      "tenantId": "tenantA",
      "facilityId": "text",
      "projectId": "text",
      "isDeleted": true,
      "rowVersion": 1,
      "auditDetails": {}
    }
  ]
}

Project Facilities

Link Resources to Project

Link Resources to Project

post

/project/resource/v1/_create

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

ProjectResourceobjectrequired

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

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/project/resource/v1/_create' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"ProjectResource":{"tenantId":"tenantA","projectId":"text","resource":{"productVariantId":"text"},"auditDetails":{}}}'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "ProjectResource": {
    "id": "text",
    "tenantId": "tenantA",
    "projectId": "text",
    "resource": {
      "productVariantId": "text"
    },
    "startDate": 1,
    "endDate": 1,
    "isDeleted": true,
    "rowVersion": 1,
    "auditDetails": {}
  }
}

Project Resource request has been accepted.

Link Resources to Project in bulk

Link Resources to Project

post

/project/resource/v1/bulk/_create

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

ProjectResourcesobject[]

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/project/resource/v1/bulk/_create' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"ProjectResources":[{"tenantId":"tenantA","projectId":"text","resource":{"productVariantId":"text"},"auditDetails":{}}]}'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  }
}

Project Resource request has been accepted.

Update Project Resource linkage

Update Project Resource linkage

post

/project/resource/v1/_update

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

ProjectResourceobjectrequired

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

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/project/resource/v1/_update' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"ProjectResource":{"tenantId":"tenantA","projectId":"text","resource":{"productVariantId":"text"},"auditDetails":{}}}'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "ProjectResource": {
    "id": "text",
    "tenantId": "tenantA",
    "projectId": "text",
    "resource": {
      "productVariantId": "text"
    },
    "startDate": 1,
    "endDate": 1,
    "isDeleted": true,
    "rowVersion": 1,
    "auditDetails": {}
  }
}

Project Resource request has been accepted

Update Project Resource linkage in bulk

Update Project Resource linkage in bulk

post

/project/resource/v1/bulk/_update

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

ProjectResourcesobject[]

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/project/resource/v1/bulk/_update' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"ProjectResources":[{"tenantId":"tenantA","projectId":"text","resource":{"productVariantId":"text"},"auditDetails":{}}]}'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  }
}

Project Resource request has been accepted

Delete Project Resource linkage

Delete Project Resource linkage

post

/project/resource/v1/_delete

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

ProjectResourceobjectrequired

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

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/project/resource/v1/_delete' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"ProjectResource":{"tenantId":"tenantA","projectId":"text","resource":{"productVariantId":"text"},"auditDetails":{}}}'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "ProjectResource": {
    "id": "text",
    "tenantId": "tenantA",
    "projectId": "text",
    "resource": {
      "productVariantId": "text"
    },
    "startDate": 1,
    "endDate": 1,
    "isDeleted": true,
    "rowVersion": 1,
    "auditDetails": {}
  }
}

Project Resource deletion request has been accepted

Delete Project Resource linkage in bulk

Delete Project Resource linkage in bulk

post

/project/resource/v1/bulk/_delete

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

ProjectResourcesobject[]

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/project/resource/v1/bulk/_delete' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"ProjectResources":[{"tenantId":"tenantA","projectId":"text","resource":{"productVariantId":"text"},"auditDetails":{}}]}'

202

400

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  }
}

Project Resource deletion request has been accepted

Search Project Resources

Search Project Resources

post

/project/resource/v1/_search

Query parameters

limitinteger · max: 1000required

Pagination - limit records in response

offsetintegerrequired

Pagination - offset from which records should be returned in response

tenantIdstring · varcharrequired

Unique id for a tenant.

lastChangedSinceinteger · int64

epoch of the time since when the changes on the object should be picked up. Search results from this parameter should include both newly created objects since this time as well as any modified objects since this time. This criterion is included to help polling clients to get the changes in system since a last time they synchronized with the platform.

includeDeletedboolean

Used in search APIs to specify if (soft) deleted records should be included in search results.

Body

RequestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

ProjectResourceobjectrequired

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

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/project/resource/v1/_search?limit=1&offset=1&tenantId=text' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"ProjectResource":{"id":[null]}}'

200

400

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "ProjectResources": [
    {
      "id": "text",
      "tenantId": "tenantA",
      "projectId": "text",
      "resource": {
        "productVariantId": "text"
      },
      "startDate": 1,
      "endDate": 1,
      "isDeleted": true,
      "rowVersion": 1,
      "auditDetails": {}
    }
  ]
}

Project Resources