Project

Project Management Service APIs

Facilitate the management of projects.

Create a new Project

post

Create a new Project

Body

apiOperationstring · enumOptional

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

Example: CREATEPossible values:

Responses

202

Project request accepted for creation.

application/json

400

Invalid Input body.

application/json

post

HTTPcURLJavaScriptPython

POST /project/v1/_create HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 2479

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "Projects": [
    {
      "tenantId": "tenantA",
      "name": "text",
      "projectType": "text",
      "projectSubType": "text",
      "department": "text",
      "description": "text",
      "referenceID": "text",
      "natureOfWork": "text",
      "ancestors": {
        "tenantId": "tenantA",
        "name": "text",
        "projectType": "text",
        "projectSubType": "text",
        "department": "text",
        "description": "text",
        "referenceID": "text",
        "natureOfWork": "text",
        "ancestors": {
          "tenantId": "tenantA",
          "name": "text",
          "projectType": "text",
          "projectSubType": "text",
          "department": "text",
          "description": "text",
          "referenceID": "text",
          "natureOfWork": "text",
          "ancestors": {
            "tenantId": "tenantA",
            "name": "text",
            "projectType": "text",
            "projectSubType": "text",
            "department": "text",
            "description": "text",
            "referenceID": "text",
            "natureOfWork": "text",
            "ancestors": "[Circular Reference]",
            "address": "[Circular Reference]",
            "startDate": 1,
            "endDate": 1,
            "isTaskEnabled": true,
            "parent": "text",
            "targets": [
              {
                "beneficiaryType": "HOUSEHOLD",
                "baseline": 1,
                "target": 1
              }
            ],
            "additionalDetails": {},
            "rowVersion": 1
          },
          "address": {
            "tenantId": "tenantA",
            "doorNo": "text",
            "latitude": 1,
            "longitude": 1,
            "locationAccuracy": 1,
            "type": [
              "PERMANENT"
            ],
            "addressLine1": "text",
            "addressLine2": "text",
            "landmark": "text",
            "city": "text",
            "pincode": "text",
            "buildingName": "text",
            "street": "text",
            "locality": "[Circular Reference]"
          },
          "startDate": 1,
          "endDate": 1,
          "isTaskEnabled": true,
          "parent": "text",
          "targets": [
            {
              "beneficiaryType": "HOUSEHOLD",
              "baseline": 1,
              "target": 1
            }
          ],
          "additionalDetails": {},
          "rowVersion": 1
        },
        "address": {
          "tenantId": "tenantA",
          "doorNo": "text",
          "latitude": 1,
          "longitude": 1,
          "locationAccuracy": 1,
          "type": [
            "PERMANENT"
          ],
          "addressLine1": "text",
          "addressLine2": "text",
          "landmark": "text",
          "city": "text",
          "pincode": "text",
          "buildingName": "text",
          "street": "text",
          "locality": "[Circular Reference]"
        },
        "startDate": 1,
        "endDate": 1,
        "isTaskEnabled": true,
        "parent": "text",
        "targets": [
          {
            "beneficiaryType": "HOUSEHOLD",
            "baseline": 1,
            "target": 1
          }
        ],
        "additionalDetails": {},
        "rowVersion": 1
      },
      "address": {
        "tenantId": "tenantA",
        "doorNo": "text",
        "latitude": 1,
        "longitude": 1,
        "locationAccuracy": 1,
        "type": [
          "PERMANENT"
        ],
        "addressLine1": "text",
        "addressLine2": "text",
        "landmark": "text",
        "city": "text",
        "pincode": "text",
        "buildingName": "text",
        "street": "text",
        "locality": "[Circular Reference]"
      },
      "startDate": 1,
      "endDate": 1,
      "isTaskEnabled": true,
      "parent": "text",
      "targets": [
        {
          "beneficiaryType": "HOUSEHOLD",
          "baseline": 1,
          "target": 1
        }
      ],
      "additionalDetails": {},
      "rowVersion": 1
    }
  ],
  "apiOperation": "CREATE"
}

{
  "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": {
        "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": {
          "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": {
            "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": "[Circular Reference]",
            "address": "[Circular Reference]",
            "startDate": 1,
            "endDate": 1,
            "isTaskEnabled": true,
            "parent": "text",
            "targets": [
              {
                "id": "text",
                "beneficiaryType": "HOUSEHOLD",
                "baseline": 1,
                "target": 1,
                "isDeleted": true,
                "auditDetails": {
                  "createdBy": "text",
                  "lastModifiedBy": "text",
                  "createdTime": 1,
                  "lastModifiedTime": 1
                }
              }
            ],
            "additionalDetails": {},
            "isDeleted": true,
            "rowVersion": 1,
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text",
              "createdTime": 1,
              "lastModifiedTime": 1
            }
          },
          "address": {
            "id": "text",
            "tenantId": "tenantA",
            "doorNo": "text",
            "latitude": 1,
            "longitude": 1,
            "locationAccuracy": 1,
            "type": [
              "PERMANENT"
            ],
            "addressLine1": "text",
            "addressLine2": "text",
            "landmark": "text",
            "city": "text",
            "pincode": "text",
            "buildingName": "text",
            "street": "text",
            "locality": "[Circular Reference]"
          },
          "startDate": 1,
          "endDate": 1,
          "isTaskEnabled": true,
          "parent": "text",
          "targets": [
            {
              "id": "text",
              "beneficiaryType": "HOUSEHOLD",
              "baseline": 1,
              "target": 1,
              "isDeleted": true,
              "auditDetails": {
                "createdBy": "text",
                "lastModifiedBy": "text",
                "createdTime": 1,
                "lastModifiedTime": 1
              }
            }
          ],
          "additionalDetails": {},
          "isDeleted": true,
          "rowVersion": 1,
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          }
        },
        "address": {
          "id": "text",
          "tenantId": "tenantA",
          "doorNo": "text",
          "latitude": 1,
          "longitude": 1,
          "locationAccuracy": 1,
          "type": [
            "PERMANENT"
          ],
          "addressLine1": "text",
          "addressLine2": "text",
          "landmark": "text",
          "city": "text",
          "pincode": "text",
          "buildingName": "text",
          "street": "text",
          "locality": "[Circular Reference]"
        },
        "startDate": 1,
        "endDate": 1,
        "isTaskEnabled": true,
        "parent": "text",
        "targets": [
          {
            "id": "text",
            "beneficiaryType": "HOUSEHOLD",
            "baseline": 1,
            "target": 1,
            "isDeleted": true,
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text",
              "createdTime": 1,
              "lastModifiedTime": 1
            }
          }
        ],
        "additionalDetails": {},
        "isDeleted": true,
        "rowVersion": 1,
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        }
      },
      "address": {
        "id": "text",
        "tenantId": "tenantA",
        "doorNo": "text",
        "latitude": 1,
        "longitude": 1,
        "locationAccuracy": 1,
        "type": [
          "PERMANENT"
        ],
        "addressLine1": "text",
        "addressLine2": "text",
        "landmark": "text",
        "city": "text",
        "pincode": "text",
        "buildingName": "text",
        "street": "text",
        "locality": "[Circular Reference]"
      },
      "startDate": 1,
      "endDate": 1,
      "isTaskEnabled": true,
      "parent": "text",
      "targets": [
        {
          "id": "text",
          "beneficiaryType": "HOUSEHOLD",
          "baseline": 1,
          "target": 1,
          "isDeleted": true,
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          }
        }
      ],
      "additionalDetails": {},
      "isDeleted": true,
      "rowVersion": 1,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    }
  ]
}

Update the details of a existing Project

post

Update the details of a existing Project

Body

apiOperationstring · enumOptional

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

Example: CREATEPossible values:

Responses

202

Employee request accepted for creation.

application/json

400

Invalid Input body.

application/json

post

HTTPcURLJavaScriptPython

POST /project/v1/_update HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 2479

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "Projects": [
    {
      "tenantId": "tenantA",
      "name": "text",
      "projectType": "text",
      "projectSubType": "text",
      "department": "text",
      "description": "text",
      "referenceID": "text",
      "natureOfWork": "text",
      "ancestors": {
        "tenantId": "tenantA",
        "name": "text",
        "projectType": "text",
        "projectSubType": "text",
        "department": "text",
        "description": "text",
        "referenceID": "text",
        "natureOfWork": "text",
        "ancestors": {
          "tenantId": "tenantA",
          "name": "text",
          "projectType": "text",
          "projectSubType": "text",
          "department": "text",
          "description": "text",
          "referenceID": "text",
          "natureOfWork": "text",
          "ancestors": {
            "tenantId": "tenantA",
            "name": "text",
            "projectType": "text",
            "projectSubType": "text",
            "department": "text",
            "description": "text",
            "referenceID": "text",
            "natureOfWork": "text",
            "ancestors": "[Circular Reference]",
            "address": "[Circular Reference]",
            "startDate": 1,
            "endDate": 1,
            "isTaskEnabled": true,
            "parent": "text",
            "targets": [
              {
                "beneficiaryType": "HOUSEHOLD",
                "baseline": 1,
                "target": 1
              }
            ],
            "additionalDetails": {},
            "rowVersion": 1
          },
          "address": {
            "tenantId": "tenantA",
            "doorNo": "text",
            "latitude": 1,
            "longitude": 1,
            "locationAccuracy": 1,
            "type": [
              "PERMANENT"
            ],
            "addressLine1": "text",
            "addressLine2": "text",
            "landmark": "text",
            "city": "text",
            "pincode": "text",
            "buildingName": "text",
            "street": "text",
            "locality": "[Circular Reference]"
          },
          "startDate": 1,
          "endDate": 1,
          "isTaskEnabled": true,
          "parent": "text",
          "targets": [
            {
              "beneficiaryType": "HOUSEHOLD",
              "baseline": 1,
              "target": 1
            }
          ],
          "additionalDetails": {},
          "rowVersion": 1
        },
        "address": {
          "tenantId": "tenantA",
          "doorNo": "text",
          "latitude": 1,
          "longitude": 1,
          "locationAccuracy": 1,
          "type": [
            "PERMANENT"
          ],
          "addressLine1": "text",
          "addressLine2": "text",
          "landmark": "text",
          "city": "text",
          "pincode": "text",
          "buildingName": "text",
          "street": "text",
          "locality": "[Circular Reference]"
        },
        "startDate": 1,
        "endDate": 1,
        "isTaskEnabled": true,
        "parent": "text",
        "targets": [
          {
            "beneficiaryType": "HOUSEHOLD",
            "baseline": 1,
            "target": 1
          }
        ],
        "additionalDetails": {},
        "rowVersion": 1
      },
      "address": {
        "tenantId": "tenantA",
        "doorNo": "text",
        "latitude": 1,
        "longitude": 1,
        "locationAccuracy": 1,
        "type": [
          "PERMANENT"
        ],
        "addressLine1": "text",
        "addressLine2": "text",
        "landmark": "text",
        "city": "text",
        "pincode": "text",
        "buildingName": "text",
        "street": "text",
        "locality": "[Circular Reference]"
      },
      "startDate": 1,
      "endDate": 1,
      "isTaskEnabled": true,
      "parent": "text",
      "targets": [
        {
          "beneficiaryType": "HOUSEHOLD",
          "baseline": 1,
          "target": 1
        }
      ],
      "additionalDetails": {},
      "rowVersion": 1
    }
  ],
  "apiOperation": "CREATE"
}

{
  "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": {
        "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": {
          "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": {
            "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": "[Circular Reference]",
            "address": "[Circular Reference]",
            "startDate": 1,
            "endDate": 1,
            "isTaskEnabled": true,
            "parent": "text",
            "targets": [
              {
                "id": "text",
                "beneficiaryType": "HOUSEHOLD",
                "baseline": 1,
                "target": 1,
                "isDeleted": true,
                "auditDetails": {
                  "createdBy": "text",
                  "lastModifiedBy": "text",
                  "createdTime": 1,
                  "lastModifiedTime": 1
                }
              }
            ],
            "additionalDetails": {},
            "isDeleted": true,
            "rowVersion": 1,
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text",
              "createdTime": 1,
              "lastModifiedTime": 1
            }
          },
          "address": {
            "id": "text",
            "tenantId": "tenantA",
            "doorNo": "text",
            "latitude": 1,
            "longitude": 1,
            "locationAccuracy": 1,
            "type": [
              "PERMANENT"
            ],
            "addressLine1": "text",
            "addressLine2": "text",
            "landmark": "text",
            "city": "text",
            "pincode": "text",
            "buildingName": "text",
            "street": "text",
            "locality": "[Circular Reference]"
          },
          "startDate": 1,
          "endDate": 1,
          "isTaskEnabled": true,
          "parent": "text",
          "targets": [
            {
              "id": "text",
              "beneficiaryType": "HOUSEHOLD",
              "baseline": 1,
              "target": 1,
              "isDeleted": true,
              "auditDetails": {
                "createdBy": "text",
                "lastModifiedBy": "text",
                "createdTime": 1,
                "lastModifiedTime": 1
              }
            }
          ],
          "additionalDetails": {},
          "isDeleted": true,
          "rowVersion": 1,
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          }
        },
        "address": {
          "id": "text",
          "tenantId": "tenantA",
          "doorNo": "text",
          "latitude": 1,
          "longitude": 1,
          "locationAccuracy": 1,
          "type": [
            "PERMANENT"
          ],
          "addressLine1": "text",
          "addressLine2": "text",
          "landmark": "text",
          "city": "text",
          "pincode": "text",
          "buildingName": "text",
          "street": "text",
          "locality": "[Circular Reference]"
        },
        "startDate": 1,
        "endDate": 1,
        "isTaskEnabled": true,
        "parent": "text",
        "targets": [
          {
            "id": "text",
            "beneficiaryType": "HOUSEHOLD",
            "baseline": 1,
            "target": 1,
            "isDeleted": true,
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text",
              "createdTime": 1,
              "lastModifiedTime": 1
            }
          }
        ],
        "additionalDetails": {},
        "isDeleted": true,
        "rowVersion": 1,
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        }
      },
      "address": {
        "id": "text",
        "tenantId": "tenantA",
        "doorNo": "text",
        "latitude": 1,
        "longitude": 1,
        "locationAccuracy": 1,
        "type": [
          "PERMANENT"
        ],
        "addressLine1": "text",
        "addressLine2": "text",
        "landmark": "text",
        "city": "text",
        "pincode": "text",
        "buildingName": "text",
        "street": "text",
        "locality": "[Circular Reference]"
      },
      "startDate": 1,
      "endDate": 1,
      "isTaskEnabled": true,
      "parent": "text",
      "targets": [
        {
          "id": "text",
          "beneficiaryType": "HOUSEHOLD",
          "baseline": 1,
          "target": 1,
          "isDeleted": true,
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          }
        }
      ],
      "additionalDetails": {},
      "isDeleted": true,
      "rowVersion": 1,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    }
  ]
}

Search for existing project

post

Search for existing project

Query parameters

limitanyRequired

Pagination - limit records in response

offsetanyRequired

Pagination - offset from which records should be returned in response

tenantIdanyRequired

Unique id for a tenant.

lastChangedSinceanyOptional

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.

includeDeletedanyOptional

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

includeAncestorsanyOptional

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

includeDescendantsanyOptional

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

createdFromanyOptional

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

createdToanyOptional

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

Body

apiOperationstring · enumOptional

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

Example: CREATEPossible values:

Responses

200

Projects.

application/json

400

Invalid Input body.

application/json

post

HTTPcURLJavaScriptPython

POST /project/v1/_search?limit=null&offset=null&tenantId=null HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 2479

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "Projects": [
    {
      "tenantId": "tenantA",
      "name": "text",
      "projectType": "text",
      "projectSubType": "text",
      "department": "text",
      "description": "text",
      "referenceID": "text",
      "natureOfWork": "text",
      "ancestors": {
        "tenantId": "tenantA",
        "name": "text",
        "projectType": "text",
        "projectSubType": "text",
        "department": "text",
        "description": "text",
        "referenceID": "text",
        "natureOfWork": "text",
        "ancestors": {
          "tenantId": "tenantA",
          "name": "text",
          "projectType": "text",
          "projectSubType": "text",
          "department": "text",
          "description": "text",
          "referenceID": "text",
          "natureOfWork": "text",
          "ancestors": {
            "tenantId": "tenantA",
            "name": "text",
            "projectType": "text",
            "projectSubType": "text",
            "department": "text",
            "description": "text",
            "referenceID": "text",
            "natureOfWork": "text",
            "ancestors": "[Circular Reference]",
            "address": "[Circular Reference]",
            "startDate": 1,
            "endDate": 1,
            "isTaskEnabled": true,
            "parent": "text",
            "targets": [
              {
                "beneficiaryType": "HOUSEHOLD",
                "baseline": 1,
                "target": 1
              }
            ],
            "additionalDetails": {},
            "rowVersion": 1
          },
          "address": {
            "tenantId": "tenantA",
            "doorNo": "text",
            "latitude": 1,
            "longitude": 1,
            "locationAccuracy": 1,
            "type": [
              "PERMANENT"
            ],
            "addressLine1": "text",
            "addressLine2": "text",
            "landmark": "text",
            "city": "text",
            "pincode": "text",
            "buildingName": "text",
            "street": "text",
            "locality": "[Circular Reference]"
          },
          "startDate": 1,
          "endDate": 1,
          "isTaskEnabled": true,
          "parent": "text",
          "targets": [
            {
              "beneficiaryType": "HOUSEHOLD",
              "baseline": 1,
              "target": 1
            }
          ],
          "additionalDetails": {},
          "rowVersion": 1
        },
        "address": {
          "tenantId": "tenantA",
          "doorNo": "text",
          "latitude": 1,
          "longitude": 1,
          "locationAccuracy": 1,
          "type": [
            "PERMANENT"
          ],
          "addressLine1": "text",
          "addressLine2": "text",
          "landmark": "text",
          "city": "text",
          "pincode": "text",
          "buildingName": "text",
          "street": "text",
          "locality": "[Circular Reference]"
        },
        "startDate": 1,
        "endDate": 1,
        "isTaskEnabled": true,
        "parent": "text",
        "targets": [
          {
            "beneficiaryType": "HOUSEHOLD",
            "baseline": 1,
            "target": 1
          }
        ],
        "additionalDetails": {},
        "rowVersion": 1
      },
      "address": {
        "tenantId": "tenantA",
        "doorNo": "text",
        "latitude": 1,
        "longitude": 1,
        "locationAccuracy": 1,
        "type": [
          "PERMANENT"
        ],
        "addressLine1": "text",
        "addressLine2": "text",
        "landmark": "text",
        "city": "text",
        "pincode": "text",
        "buildingName": "text",
        "street": "text",
        "locality": "[Circular Reference]"
      },
      "startDate": 1,
      "endDate": 1,
      "isTaskEnabled": true,
      "parent": "text",
      "targets": [
        {
          "beneficiaryType": "HOUSEHOLD",
          "baseline": 1,
          "target": 1
        }
      ],
      "additionalDetails": {},
      "rowVersion": 1
    }
  ],
  "apiOperation": "CREATE"
}

{
  "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": {
        "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": {
          "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": {
            "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": "[Circular Reference]",
            "address": "[Circular Reference]",
            "startDate": 1,
            "endDate": 1,
            "isTaskEnabled": true,
            "parent": "text",
            "targets": [
              {
                "id": "text",
                "beneficiaryType": "HOUSEHOLD",
                "baseline": 1,
                "target": 1,
                "isDeleted": true,
                "auditDetails": {
                  "createdBy": "text",
                  "lastModifiedBy": "text",
                  "createdTime": 1,
                  "lastModifiedTime": 1
                }
              }
            ],
            "additionalDetails": {},
            "isDeleted": true,
            "rowVersion": 1,
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text",
              "createdTime": 1,
              "lastModifiedTime": 1
            }
          },
          "address": {
            "id": "text",
            "tenantId": "tenantA",
            "doorNo": "text",
            "latitude": 1,
            "longitude": 1,
            "locationAccuracy": 1,
            "type": [
              "PERMANENT"
            ],
            "addressLine1": "text",
            "addressLine2": "text",
            "landmark": "text",
            "city": "text",
            "pincode": "text",
            "buildingName": "text",
            "street": "text",
            "locality": "[Circular Reference]"
          },
          "startDate": 1,
          "endDate": 1,
          "isTaskEnabled": true,
          "parent": "text",
          "targets": [
            {
              "id": "text",
              "beneficiaryType": "HOUSEHOLD",
              "baseline": 1,
              "target": 1,
              "isDeleted": true,
              "auditDetails": {
                "createdBy": "text",
                "lastModifiedBy": "text",
                "createdTime": 1,
                "lastModifiedTime": 1
              }
            }
          ],
          "additionalDetails": {},
          "isDeleted": true,
          "rowVersion": 1,
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          }
        },
        "address": {
          "id": "text",
          "tenantId": "tenantA",
          "doorNo": "text",
          "latitude": 1,
          "longitude": 1,
          "locationAccuracy": 1,
          "type": [
            "PERMANENT"
          ],
          "addressLine1": "text",
          "addressLine2": "text",
          "landmark": "text",
          "city": "text",
          "pincode": "text",
          "buildingName": "text",
          "street": "text",
          "locality": "[Circular Reference]"
        },
        "startDate": 1,
        "endDate": 1,
        "isTaskEnabled": true,
        "parent": "text",
        "targets": [
          {
            "id": "text",
            "beneficiaryType": "HOUSEHOLD",
            "baseline": 1,
            "target": 1,
            "isDeleted": true,
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text",
              "createdTime": 1,
              "lastModifiedTime": 1
            }
          }
        ],
        "additionalDetails": {},
        "isDeleted": true,
        "rowVersion": 1,
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        }
      },
      "address": {
        "id": "text",
        "tenantId": "tenantA",
        "doorNo": "text",
        "latitude": 1,
        "longitude": 1,
        "locationAccuracy": 1,
        "type": [
          "PERMANENT"
        ],
        "addressLine1": "text",
        "addressLine2": "text",
        "landmark": "text",
        "city": "text",
        "pincode": "text",
        "buildingName": "text",
        "street": "text",
        "locality": "[Circular Reference]"
      },
      "startDate": 1,
      "endDate": 1,
      "isTaskEnabled": true,
      "parent": "text",
      "targets": [
        {
          "id": "text",
          "beneficiaryType": "HOUSEHOLD",
          "baseline": 1,
          "target": 1,
          "isDeleted": true,
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          }
        }
      ],
      "additionalDetails": {},
      "isDeleted": true,
      "rowVersion": 1,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    }
  ]
}

Add beneficiary for project

post

Add beneficiary for project

Body

Responses

202

add beneficiary request has been accepted for creation.

application/json

400

Invalid Input body.

application/json

post

HTTPcURLJavaScriptPython

POST /project/beneficiary/v1/_create HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 441

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "ProjectBeneficiary": {
    "clientReferenceId": "text",
    "tenantId": "tenantA",
    "projectId": "text",
    "beneficiaryId": "text",
    "beneficiaryClientReferenceId": "text",
    "dateOfRegistration": 1663218161,
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    },
    "rowVersion": 1
  }
}

{
  "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": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    }
  }
}

Add beneficiaries for project

post

Add beneficiaries for project

Body

Responses

202

add beneficiary request has been accepted for creation.

application/json

400

Invalid Input body.

application/json

post

HTTPcURLJavaScriptPython

POST /project/beneficiary/v1/bulk/_create HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 445

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "ProjectBeneficiaries": [
    {
      "clientReferenceId": "text",
      "tenantId": "tenantA",
      "projectId": "text",
      "beneficiaryId": "text",
      "beneficiaryClientReferenceId": "text",
      "dateOfRegistration": 1663218161,
      "additionalFields": {
        "schema": "HOUSEHOLD",
        "version": 2,
        "fields": [
          {
            "key": "height",
            "value": 180
          }
        ]
      },
      "rowVersion": 1
    }
  ]
}

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

Update beneficiary registration for project

post

Update beneficiary registration for project

Query parameters

echoResourceanyOptional

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

Responses

202

Project Beneficiary request has been accepted.

application/json

400

Invalid Input body.

application/json

post

HTTPcURLJavaScriptPython

POST /project/beneficiary/v1/_update HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 441

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "ProjectBeneficiary": {
    "clientReferenceId": "text",
    "tenantId": "tenantA",
    "projectId": "text",
    "beneficiaryId": "text",
    "beneficiaryClientReferenceId": "text",
    "dateOfRegistration": 1663218161,
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    },
    "rowVersion": 1
  }
}

{
  "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": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    }
  }
}

Update beneficiaries registration for project

post

Update beneficiaries registration for project

Query parameters

echoResourceanyOptional

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

Responses

202

Project Beneficiary request has been accepted.

application/json

400

Invalid Input body.

application/json

post

HTTPcURLJavaScriptPython

POST /project/beneficiary/v1/bulk/_update HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 445

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "ProjectBeneficiaries": [
    {
      "clientReferenceId": "text",
      "tenantId": "tenantA",
      "projectId": "text",
      "beneficiaryId": "text",
      "beneficiaryClientReferenceId": "text",
      "dateOfRegistration": 1663218161,
      "additionalFields": {
        "schema": "HOUSEHOLD",
        "version": 2,
        "fields": [
          {
            "key": "height",
            "value": 180
          }
        ]
      },
      "rowVersion": 1
    }
  ]
}

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

Soft delete beneficiary registration for project

post

Soft delete registration for project

Query parameters

echoResourceanyOptional

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

Responses

202

Project Beneficiary request has been accepted.

application/json

400

Invalid Input body.

application/json

post

HTTPcURLJavaScriptPython

POST /project/beneficiary/v1/_delete HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 441

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "ProjectBeneficiary": {
    "clientReferenceId": "text",
    "tenantId": "tenantA",
    "projectId": "text",
    "beneficiaryId": "text",
    "beneficiaryClientReferenceId": "text",
    "dateOfRegistration": 1663218161,
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    },
    "rowVersion": 1
  }
}

{
  "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": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    }
  }
}

Update beneficiaries registration for project

post

Update beneficiaries registration for project

Query parameters

echoResourceanyOptional

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

Responses

202

Project Beneficiary request has been accepted.

application/json

400

Invalid Input body.

application/json

post

HTTPcURLJavaScriptPython

POST /project/beneficiary/v1/bulk/_delete HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 445

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "ProjectBeneficiaries": [
    {
      "clientReferenceId": "text",
      "tenantId": "tenantA",
      "projectId": "text",
      "beneficiaryId": "text",
      "beneficiaryClientReferenceId": "text",
      "dateOfRegistration": 1663218161,
      "additionalFields": {
        "schema": "HOUSEHOLD",
        "version": 2,
        "fields": [
          {
            "key": "height",
            "value": 180
          }
        ]
      },
      "rowVersion": 1
    }
  ]
}

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

Search beneficiary registration for Project

post

Search beneficiary registration for Project

Query parameters

limitanyRequired

Pagination - limit records in response

offsetanyRequired

Pagination - offset from which records should be returned in response

tenantIdanyRequired

Unique id for a tenant.

lastChangedSinceanyOptional

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.

includeDeletedanyOptional

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

Body

Responses

200

Project Beneficaries.

application/json

400

Invalid Input body.

application/json

post

HTTPcURLJavaScriptPython

POST /project/beneficiary/v1/_search?limit=null&offset=null&tenantId=null HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 289

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "ProjectBeneficiary": {
    "id": [
      "text"
    ],
    "clientReferenceId": [
      "text"
    ],
    "projectId": "text",
    "beneficiaryId": "text",
    "dateOfRegistration": 1663218161
  }
}

{
  "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": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    }
  ]
}

Create task for the project

post

Create task for the project

Body

Responses

202

Create task request has been accepted for creation.

application/json

400

Invalid Input body.

application/json

post

HTTPcURLJavaScriptPython

POST /project/task/v1/_create HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 1147

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "Task": {
    "clientReferenceId": "text",
    "tenantId": "tenantA",
    "projectId": "text",
    "projectBeneficiaryId": "R-ID-1",
    "projectBeneficiaryClientReferenceId": "R-ID-1",
    "resources": [
      {
        "tenantId": "tenantA",
        "productVariantId": "ID-1",
        "quantity": 1,
        "isDelivered": true,
        "deliveryComment": "text"
      }
    ],
    "plannedStartDate": 1,
    "plannedEndDate": 1,
    "actualStartDate": 1,
    "actualEndDate": 1,
    "createdBy": "UUID",
    "createdDate": 1663218161,
    "address": {
      "tenantId": "tenantA",
      "doorNo": "text",
      "latitude": 1,
      "longitude": 1,
      "locationAccuracy": 1,
      "type": [
        "PERMANENT"
      ],
      "addressLine1": "text",
      "addressLine2": "text",
      "landmark": "text",
      "city": "text",
      "pincode": "text",
      "buildingName": "text",
      "street": "text",
      "locality": {
        "code": "text",
        "name": "text",
        "label": "text",
        "latitude": "text",
        "longitude": "text",
        "children": [
          {
            "code": "text",
            "name": "text",
            "label": "text",
            "latitude": "text",
            "longitude": "text",
            "children": "[Circular Reference]"
          }
        ]
      }
    },
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    },
    "rowVersion": 1,
    "status": "DELIVERED"
  }
}

{
  "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",
    "resources": [
      {
        "id": "text",
        "tenantId": "tenantA",
        "productVariantId": "ID-1",
        "quantity": 1,
        "isDelivered": true,
        "deliveryComment": "text",
        "isDeleted": true,
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        }
      }
    ],
    "plannedStartDate": 1,
    "plannedEndDate": 1,
    "actualStartDate": 1,
    "actualEndDate": 1,
    "createdBy": "UUID",
    "createdDate": 1663218161,
    "address": {
      "id": "text",
      "tenantId": "tenantA",
      "doorNo": "text",
      "latitude": 1,
      "longitude": 1,
      "locationAccuracy": 1,
      "type": [
        "PERMANENT"
      ],
      "addressLine1": "text",
      "addressLine2": "text",
      "landmark": "text",
      "city": "text",
      "pincode": "text",
      "buildingName": "text",
      "street": "text",
      "locality": {
        "code": "text",
        "name": "text",
        "label": "text",
        "latitude": "text",
        "longitude": "text",
        "children": [
          {
            "code": "text",
            "name": "text",
            "label": "text",
            "latitude": "text",
            "longitude": "text",
            "children": "[Circular Reference]",
            "materializedPath": "text"
          }
        ],
        "materializedPath": "text"
      }
    },
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    },
    "isDeleted": true,
    "rowVersion": 1,
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "status": "DELIVERED"
  }
}

Create tasks for the project in bulk

post

Create tasks for the project in bulk

Body

Responses

202

Create task request has been accepted for creation.

application/json

400

Invalid Input body.

application/json

post

HTTPcURLJavaScriptPython

POST /project/task/v1/bulk/_create HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 1057

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "Tasks": [
    {
      "clientReferenceId": "text",
      "tenantId": "tenantA",
      "projectId": "text",
      "projectBeneficiaryId": "R-ID-1",
      "projectBeneficiaryClientReferenceId": "R-ID-1",
      "resources": [
        {
          "tenantId": "tenantA",
          "productVariantId": "ID-1",
          "quantity": 1,
          "isDelivered": true,
          "deliveryComment": "text"
        }
      ],
      "plannedStartDate": 1,
      "plannedEndDate": 1,
      "actualStartDate": 1,
      "actualEndDate": 1,
      "createdBy": "UUID",
      "createdDate": 1663218161,
      "address": {
        "tenantId": "tenantA",
        "doorNo": "text",
        "latitude": 1,
        "longitude": 1,
        "locationAccuracy": 1,
        "type": [
          "PERMANENT"
        ],
        "addressLine1": "text",
        "addressLine2": "text",
        "landmark": "text",
        "city": "text",
        "pincode": "text",
        "buildingName": "text",
        "street": "text",
        "locality": {
          "code": "text",
          "name": "text",
          "label": "text",
          "latitude": "text",
          "longitude": "text",
          "children": [
            "[Circular Reference]"
          ]
        }
      },
      "additionalFields": {
        "schema": "HOUSEHOLD",
        "version": 2,
        "fields": [
          {
            "key": "height",
            "value": 180
          }
        ]
      },
      "rowVersion": 1,
      "status": "DELIVERED"
    }
  ]
}

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

Task Request

post

Task Request

Body

Responses

202

update task request has been accepted for update.

application/json

400

Invalid Input body.

application/json

post

HTTPcURLJavaScriptPython

POST /project/task/v1/_update HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 1147

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "Task": {
    "clientReferenceId": "text",
    "tenantId": "tenantA",
    "projectId": "text",
    "projectBeneficiaryId": "R-ID-1",
    "projectBeneficiaryClientReferenceId": "R-ID-1",
    "resources": [
      {
        "tenantId": "tenantA",
        "productVariantId": "ID-1",
        "quantity": 1,
        "isDelivered": true,
        "deliveryComment": "text"
      }
    ],
    "plannedStartDate": 1,
    "plannedEndDate": 1,
    "actualStartDate": 1,
    "actualEndDate": 1,
    "createdBy": "UUID",
    "createdDate": 1663218161,
    "address": {
      "tenantId": "tenantA",
      "doorNo": "text",
      "latitude": 1,
      "longitude": 1,
      "locationAccuracy": 1,
      "type": [
        "PERMANENT"
      ],
      "addressLine1": "text",
      "addressLine2": "text",
      "landmark": "text",
      "city": "text",
      "pincode": "text",
      "buildingName": "text",
      "street": "text",
      "locality": {
        "code": "text",
        "name": "text",
        "label": "text",
        "latitude": "text",
        "longitude": "text",
        "children": [
          {
            "code": "text",
            "name": "text",
            "label": "text",
            "latitude": "text",
            "longitude": "text",
            "children": "[Circular Reference]"
          }
        ]
      }
    },
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    },
    "rowVersion": 1,
    "status": "DELIVERED"
  }
}

{
  "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",
    "resources": [
      {
        "id": "text",
        "tenantId": "tenantA",
        "productVariantId": "ID-1",
        "quantity": 1,
        "isDelivered": true,
        "deliveryComment": "text",
        "isDeleted": true,
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        }
      }
    ],
    "plannedStartDate": 1,
    "plannedEndDate": 1,
    "actualStartDate": 1,
    "actualEndDate": 1,
    "createdBy": "UUID",
    "createdDate": 1663218161,
    "address": {
      "id": "text",
      "tenantId": "tenantA",
      "doorNo": "text",
      "latitude": 1,
      "longitude": 1,
      "locationAccuracy": 1,
      "type": [
        "PERMANENT"
      ],
      "addressLine1": "text",
      "addressLine2": "text",
      "landmark": "text",
      "city": "text",
      "pincode": "text",
      "buildingName": "text",
      "street": "text",
      "locality": {
        "code": "text",
        "name": "text",
        "label": "text",
        "latitude": "text",
        "longitude": "text",
        "children": [
          {
            "code": "text",
            "name": "text",
            "label": "text",
            "latitude": "text",
            "longitude": "text",
            "children": "[Circular Reference]",
            "materializedPath": "text"
          }
        ],
        "materializedPath": "text"
      }
    },
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    },
    "isDeleted": true,
    "rowVersion": 1,
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "status": "DELIVERED"
  }
}

Task Request in bulk for a project

post

Task Request in bulk for a project

Body

Responses

202

update tasks bulk request has been accepted for update.

application/json

400

Invalid Input body.

application/json

post

HTTPcURLJavaScriptPython

POST /project/task/v1/bulk/_update HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 1057

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "Tasks": [
    {
      "clientReferenceId": "text",
      "tenantId": "tenantA",
      "projectId": "text",
      "projectBeneficiaryId": "R-ID-1",
      "projectBeneficiaryClientReferenceId": "R-ID-1",
      "resources": [
        {
          "tenantId": "tenantA",
          "productVariantId": "ID-1",
          "quantity": 1,
          "isDelivered": true,
          "deliveryComment": "text"
        }
      ],
      "plannedStartDate": 1,
      "plannedEndDate": 1,
      "actualStartDate": 1,
      "actualEndDate": 1,
      "createdBy": "UUID",
      "createdDate": 1663218161,
      "address": {
        "tenantId": "tenantA",
        "doorNo": "text",
        "latitude": 1,
        "longitude": 1,
        "locationAccuracy": 1,
        "type": [
          "PERMANENT"
        ],
        "addressLine1": "text",
        "addressLine2": "text",
        "landmark": "text",
        "city": "text",
        "pincode": "text",
        "buildingName": "text",
        "street": "text",
        "locality": {
          "code": "text",
          "name": "text",
          "label": "text",
          "latitude": "text",
          "longitude": "text",
          "children": [
            "[Circular Reference]"
          ]
        }
      },
      "additionalFields": {
        "schema": "HOUSEHOLD",
        "version": 2,
        "fields": [
          {
            "key": "height",
            "value": 180
          }
        ]
      },
      "rowVersion": 1,
      "status": "DELIVERED"
    }
  ]
}

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

Soft delete Task for a project

post

Soft delete Task for a project

Body

Responses

202

delete task request has been accepted for deletion.

application/json

400

Invalid Input body.

application/json

post

HTTPcURLJavaScriptPython

POST /project/task/v1/_delete HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 1147

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "Task": {
    "clientReferenceId": "text",
    "tenantId": "tenantA",
    "projectId": "text",
    "projectBeneficiaryId": "R-ID-1",
    "projectBeneficiaryClientReferenceId": "R-ID-1",
    "resources": [
      {
        "tenantId": "tenantA",
        "productVariantId": "ID-1",
        "quantity": 1,
        "isDelivered": true,
        "deliveryComment": "text"
      }
    ],
    "plannedStartDate": 1,
    "plannedEndDate": 1,
    "actualStartDate": 1,
    "actualEndDate": 1,
    "createdBy": "UUID",
    "createdDate": 1663218161,
    "address": {
      "tenantId": "tenantA",
      "doorNo": "text",
      "latitude": 1,
      "longitude": 1,
      "locationAccuracy": 1,
      "type": [
        "PERMANENT"
      ],
      "addressLine1": "text",
      "addressLine2": "text",
      "landmark": "text",
      "city": "text",
      "pincode": "text",
      "buildingName": "text",
      "street": "text",
      "locality": {
        "code": "text",
        "name": "text",
        "label": "text",
        "latitude": "text",
        "longitude": "text",
        "children": [
          {
            "code": "text",
            "name": "text",
            "label": "text",
            "latitude": "text",
            "longitude": "text",
            "children": "[Circular Reference]"
          }
        ]
      }
    },
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    },
    "rowVersion": 1,
    "status": "DELIVERED"
  }
}

{
  "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",
    "resources": [
      {
        "id": "text",
        "tenantId": "tenantA",
        "productVariantId": "ID-1",
        "quantity": 1,
        "isDelivered": true,
        "deliveryComment": "text",
        "isDeleted": true,
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        }
      }
    ],
    "plannedStartDate": 1,
    "plannedEndDate": 1,
    "actualStartDate": 1,
    "actualEndDate": 1,
    "createdBy": "UUID",
    "createdDate": 1663218161,
    "address": {
      "id": "text",
      "tenantId": "tenantA",
      "doorNo": "text",
      "latitude": 1,
      "longitude": 1,
      "locationAccuracy": 1,
      "type": [
        "PERMANENT"
      ],
      "addressLine1": "text",
      "addressLine2": "text",
      "landmark": "text",
      "city": "text",
      "pincode": "text",
      "buildingName": "text",
      "street": "text",
      "locality": {
        "code": "text",
        "name": "text",
        "label": "text",
        "latitude": "text",
        "longitude": "text",
        "children": [
          {
            "code": "text",
            "name": "text",
            "label": "text",
            "latitude": "text",
            "longitude": "text",
            "children": "[Circular Reference]",
            "materializedPath": "text"
          }
        ],
        "materializedPath": "text"
      }
    },
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    },
    "isDeleted": true,
    "rowVersion": 1,
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "status": "DELIVERED"
  }
}

Soft delete Tasks for a project

post

Soft delete Tasks for a project

Body

Responses

202

delete bulk task request has been accepted for deletion.

application/json

400

Invalid Input body.

application/json

post

HTTPcURLJavaScriptPython

POST /project/task/v1/bulk/_delete HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 1057

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "Tasks": [
    {
      "clientReferenceId": "text",
      "tenantId": "tenantA",
      "projectId": "text",
      "projectBeneficiaryId": "R-ID-1",
      "projectBeneficiaryClientReferenceId": "R-ID-1",
      "resources": [
        {
          "tenantId": "tenantA",
          "productVariantId": "ID-1",
          "quantity": 1,
          "isDelivered": true,
          "deliveryComment": "text"
        }
      ],
      "plannedStartDate": 1,
      "plannedEndDate": 1,
      "actualStartDate": 1,
      "actualEndDate": 1,
      "createdBy": "UUID",
      "createdDate": 1663218161,
      "address": {
        "tenantId": "tenantA",
        "doorNo": "text",
        "latitude": 1,
        "longitude": 1,
        "locationAccuracy": 1,
        "type": [
          "PERMANENT"
        ],
        "addressLine1": "text",
        "addressLine2": "text",
        "landmark": "text",
        "city": "text",
        "pincode": "text",
        "buildingName": "text",
        "street": "text",
        "locality": {
          "code": "text",
          "name": "text",
          "label": "text",
          "latitude": "text",
          "longitude": "text",
          "children": [
            "[Circular Reference]"
          ]
        }
      },
      "additionalFields": {
        "schema": "HOUSEHOLD",
        "version": 2,
        "fields": [
          {
            "key": "height",
            "value": 180
          }
        ]
      },
      "rowVersion": 1,
      "status": "DELIVERED"
    }
  ]
}

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

Search task for Project

post

Search task for Project

Query parameters

limitanyRequired

Pagination - limit records in response

offsetanyRequired

Pagination - offset from which records should be returned in response

tenantIdanyRequired

Unique id for a tenant.

lastChangedSinceanyOptional

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.

includeDeletedanyOptional

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

Body

Responses

200

Project Tasks.

application/json

400

Invalid Input body.

application/json

post

HTTPcURLJavaScriptPython

POST /project/task/v1/_search?limit=null&offset=null&tenantId=null HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 392

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "Task": {
    "id": [
      "text"
    ],
    "clientReferenceId": [
      "text"
    ],
    "projectId": "text",
    "projectBeneficiaryId": "R-ID-1",
    "plannedStartDate": 1,
    "plannedEndDate": 1,
    "actualStartDate": 1,
    "actualEndDate": 1,
    "createdBy": "UUID",
    "status": "DELIVERED",
    "boundaryCode": "text"
  }
}

{
  "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",
      "resources": [
        {
          "id": "text",
          "tenantId": "tenantA",
          "productVariantId": "ID-1",
          "quantity": 1,
          "isDelivered": true,
          "deliveryComment": "text",
          "isDeleted": true,
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          }
        }
      ],
      "plannedStartDate": 1,
      "plannedEndDate": 1,
      "actualStartDate": 1,
      "actualEndDate": 1,
      "createdBy": "UUID",
      "createdDate": 1663218161,
      "address": {
        "id": "text",
        "tenantId": "tenantA",
        "doorNo": "text",
        "latitude": 1,
        "longitude": 1,
        "locationAccuracy": 1,
        "type": [
          "PERMANENT"
        ],
        "addressLine1": "text",
        "addressLine2": "text",
        "landmark": "text",
        "city": "text",
        "pincode": "text",
        "buildingName": "text",
        "street": "text",
        "locality": {
          "code": "text",
          "name": "text",
          "label": "text",
          "latitude": "text",
          "longitude": "text",
          "children": [
            "[Circular Reference]"
          ],
          "materializedPath": "text"
        }
      },
      "additionalFields": {
        "schema": "HOUSEHOLD",
        "version": 2,
        "fields": [
          {
            "key": "height",
            "value": 180
          }
        ]
      },
      "isDeleted": true,
      "rowVersion": 1,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "status": "DELIVERED"
    }
  ]
}

Link Staff users to Project for a certain time period

post

Link Staff users to Project for a certain time period

Body

Responses

202

Project Staff request has been accepted.

application/json

400

Invalid Input body.

application/json

post

HTTPcURLJavaScriptPython

POST /project/staff/v1/_create HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 280

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "ProjectStaff": {
    "tenantId": "tenantA",
    "userId": "text",
    "projectId": "text",
    "startDate": 1,
    "endDate": 1,
    "channel": "text",
    "rowVersion": 1
  }
}

{
  "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": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    }
  }
}

Link bulk Staff users to Project for a certain time period

post

Link bulk Staff users to Project for a certain time period

Body

Responses

202

Project Staff request has been accepted.

application/json

400

Invalid Input body.

application/json

post

HTTPcURLJavaScriptPython

POST /project/staff/v1/bulk/_create HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 282

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "ProjectStaff": [
    {
      "tenantId": "tenantA",
      "userId": "text",
      "projectId": "text",
      "startDate": 1,
      "endDate": 1,
      "channel": "text",
      "rowVersion": 1
    }
  ]
}

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

Update Project Staff users

post

Update Project Staff users

Body

Responses

202

Project Staff request has been accepted for updation.

application/json

400

Invalid Input body.

application/json

post

HTTPcURLJavaScriptPython

POST /project/staff/v1/_update HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 280

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "ProjectStaff": {
    "tenantId": "tenantA",
    "userId": "text",
    "projectId": "text",
    "startDate": 1,
    "endDate": 1,
    "channel": "text",
    "rowVersion": 1
  }
}

{
  "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": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    }
  }
}

Update Project Staff users using bulk payload

post

Update Project Staff users using bulk payload

Body

Responses

202

Project Staff bulk request has been accepted for update.

application/json

400

Invalid Input body.

application/json

post

HTTPcURLJavaScriptPython

POST /project/staff/v1/bulk/_update HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 282

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "ProjectStaff": [
    {
      "tenantId": "tenantA",
      "userId": "text",
      "projectId": "text",
      "startDate": 1,
      "endDate": 1,
      "channel": "text",
      "rowVersion": 1
    }
  ]
}

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

Soft delete linkage of Project Staff users with project

post

Soft delete linkage of Project Staff users with project

Body

Responses

202

Project Staff request has been accepted for deletion.

application/json

400

Invalid Input body.

application/json

post

HTTPcURLJavaScriptPython

POST /project/staff/v1/_delete HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 280

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "ProjectStaff": {
    "tenantId": "tenantA",
    "userId": "text",
    "projectId": "text",
    "startDate": 1,
    "endDate": 1,
    "channel": "text",
    "rowVersion": 1
  }
}

{
  "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": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    }
  }
}

Soft delete linkage of Project Staff users with project in bulk

post

Soft delete linkage of Project Staff users with project in bulk

Body

Responses

202

Project Staff request has been accepted for deletion.

application/json

400

Invalid Input body.

application/json

post

HTTPcURLJavaScriptPython

POST /project/staff/v1/bulk/_delete HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 282

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "ProjectStaff": [
    {
      "tenantId": "tenantA",
      "userId": "text",
      "projectId": "text",
      "startDate": 1,
      "endDate": 1,
      "channel": "text",
      "rowVersion": 1
    }
  ]
}

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

Search Project Staff users

post

Search Project Staff users

Query parameters

limitanyRequired

Pagination - limit records in response

offsetanyRequired

Pagination - offset from which records should be returned in response

tenantIdanyRequired

Unique id for a tenant.

lastChangedSinceanyOptional

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.

includeDeletedanyOptional

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

Body

Responses

200

Project Staff.

application/json

400

Invalid Input body.

application/json

post

HTTPcURLJavaScriptPython

POST /project/staff/v1/_search?limit=null&offset=null&tenantId=null HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 242

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "ProjectStaff": {
    "id": [
      "text"
    ],
    "staffId": "text",
    "projectId": "text",
    "startDate": 1,
    "endDate": 1
  }
}

{
  "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": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    }
  ]
}

Link Facility to Project

post

Link Facility to Project

Body

apiOperationstring · enumOptional

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

Example: CREATEPossible values:

Responses

202

Project Staff request has been accepted.

application/json

400

Invalid Input body.

application/json

post

HTTPcURLJavaScriptPython

POST /project/facility/v1/_create HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 268

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "ProjectFacility": {
    "tenantId": "tenantA",
    "facilityId": "text",
    "projectId": "text",
    "rowVersion": 1
  },
  "apiOperation": "CREATE"
}

{
  "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": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    }
  }
}

Link Facilities to Project

post

Link Facilities to Project

Body

apiOperationstring · enumOptional

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

Example: CREATEPossible values:

Responses

202

Project Staff request has been accepted.

application/json

400

Invalid Input body.

application/json

post

HTTPcURLJavaScriptPython

POST /project/facility/v1/bulk/_create HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 272

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "ProjectFacilities": [
    {
      "tenantId": "tenantA",
      "facilityId": "text",
      "projectId": "text",
      "rowVersion": 1
    }
  ],
  "apiOperation": "CREATE"
}

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

Update Project Facilities

post

Update Project Facilities

Body

apiOperationstring · enumOptional

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

Example: CREATEPossible values:

Responses

202

Project Facility request has been accepted

application/json

400

Invalid Input body.

application/json

post

HTTPcURLJavaScriptPython

POST /project/facility/v1/_update HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 268

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "ProjectFacility": {
    "tenantId": "tenantA",
    "facilityId": "text",
    "projectId": "text",
    "rowVersion": 1
  },
  "apiOperation": "CREATE"
}

{
  "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": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    }
  }
}

Update Project Facilities

post

Update Project Facilities

Body

apiOperationstring · enumOptional

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

Example: CREATEPossible values:

Responses

202

Project Facility request has been accepted

application/json

400

Invalid Input body.

application/json

post

HTTPcURLJavaScriptPython

POST /project/facility/v1/bulk/_update HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 272

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "ProjectFacilities": [
    {
      "tenantId": "tenantA",
      "facilityId": "text",
      "projectId": "text",
      "rowVersion": 1
    }
  ],
  "apiOperation": "CREATE"
}

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

Soft delete Project Facility

post

Soft delete Project Facility

Body

apiOperationstring · enumOptional

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

Example: CREATEPossible values:

Responses

202

Project Facility delete request has been accepted

application/json

400

Invalid Input body.

application/json

post

HTTPcURLJavaScriptPython

POST /project/facility/v1/_delete HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 268

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "ProjectFacility": {
    "tenantId": "tenantA",
    "facilityId": "text",
    "projectId": "text",
    "rowVersion": 1
  },
  "apiOperation": "CREATE"
}

{
  "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": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    }
  }
}

Soft delete Project Facilities in bulk

post

Soft delete Project Facilities in bulk

Body

apiOperationstring · enumOptional

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

Example: CREATEPossible values:

Responses

202

Project Facility delete request has been accepted

application/json

400

Invalid Input body.

application/json

post

HTTPcURLJavaScriptPython

POST /project/facility/v1/bulk/_delete HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 272

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "ProjectFacilities": [
    {
      "tenantId": "tenantA",
      "facilityId": "text",
      "projectId": "text",
      "rowVersion": 1
    }
  ],
  "apiOperation": "CREATE"
}

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

Search Project Facilities

post

Search Project Facilities

Query parameters

limitanyRequired

Pagination - limit records in response

offsetanyRequired

Pagination - offset from which records should be returned in response

tenantIdanyRequired

Unique id for a tenant.

lastChangedSinceanyOptional

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.

includeDeletedanyOptional

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

Body

Responses

200

Project Facilities

application/json

400

Invalid Input body.

application/json

post

HTTPcURLJavaScriptPython

POST /project/facility/v1/_search?limit=null&offset=null&tenantId=null HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 226

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "ProjectFacility": {
    "id": [
      "text"
    ],
    "facilityId": [
      "text"
    ],
    "projectId": [
      "text"
    ]
  }
}

{
  "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": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    }
  ]
}

Link Resources to Project

post

Link Resources to Project

Body

Responses

202

Project Resource request has been accepted.

application/json

400

Invalid Input body.

application/json

post

HTTPcURLJavaScriptPython

POST /project/resource/v1/_create HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 328

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "ProjectResource": {
    "tenantId": "tenantA",
    "projectId": "text",
    "resource": {
      "productVariantId": "text",
      "type": "text",
      "isBaseUnitVariant": true
    },
    "startDate": 1,
    "endDate": 1,
    "rowVersion": 1
  }
}

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

Link Resources to Project in bulk

post

Link Resources to Project

Body

Responses

202

Project Resource request has been accepted.

application/json

400

Invalid Input body.

application/json

post

HTTPcURLJavaScriptPython

POST /project/resource/v1/bulk/_create HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 331

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "ProjectResources": [
    {
      "tenantId": "tenantA",
      "projectId": "text",
      "resource": {
        "productVariantId": "text",
        "type": "text",
        "isBaseUnitVariant": true
      },
      "startDate": 1,
      "endDate": 1,
      "rowVersion": 1
    }
  ]
}

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

Update Project Resource linkage

post

Update Project Resource linkage

Body

Responses

202

Project Resource request has been accepted

application/json

400

Invalid Input body.

application/json

post

HTTPcURLJavaScriptPython

POST /project/resource/v1/_update HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 328

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "ProjectResource": {
    "tenantId": "tenantA",
    "projectId": "text",
    "resource": {
      "productVariantId": "text",
      "type": "text",
      "isBaseUnitVariant": true
    },
    "startDate": 1,
    "endDate": 1,
    "rowVersion": 1
  }
}

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

Update Project Resource linkage in bulk

post

Update Project Resource linkage in bulk

Body

Responses

202

Project Resource request has been accepted

application/json

400

Invalid Input body.

application/json

post

HTTPcURLJavaScriptPython

POST /project/resource/v1/bulk/_update HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 331

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "ProjectResources": [
    {
      "tenantId": "tenantA",
      "projectId": "text",
      "resource": {
        "productVariantId": "text",
        "type": "text",
        "isBaseUnitVariant": true
      },
      "startDate": 1,
      "endDate": 1,
      "rowVersion": 1
    }
  ]
}

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

Delete Project Resource linkage

post

Delete Project Resource linkage

Body

Responses

202

Project Resource deletion request has been accepted

application/json

400

Invalid Input body.

application/json

post

HTTPcURLJavaScriptPython

POST /project/resource/v1/_delete HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 328

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "ProjectResource": {
    "tenantId": "tenantA",
    "projectId": "text",
    "resource": {
      "productVariantId": "text",
      "type": "text",
      "isBaseUnitVariant": true
    },
    "startDate": 1,
    "endDate": 1,
    "rowVersion": 1
  }
}

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

Delete Project Resource linkage in bulk

post

Delete Project Resource linkage in bulk

Body

Responses

202

Project Resource deletion request has been accepted

application/json

400

Invalid Input body.

application/json

post

HTTPcURLJavaScriptPython

POST /project/resource/v1/bulk/_delete HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 331

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "ProjectResources": [
    {
      "tenantId": "tenantA",
      "projectId": "text",
      "resource": {
        "productVariantId": "text",
        "type": "text",
        "isBaseUnitVariant": true
      },
      "startDate": 1,
      "endDate": 1,
      "rowVersion": 1
    }
  ]
}

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

Search Project Resources

post

Search Project Resources

Query parameters

limitanyRequired

Pagination - limit records in response

offsetanyRequired

Pagination - offset from which records should be returned in response

tenantIdanyRequired

Unique id for a tenant.

lastChangedSinceanyOptional

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.

includeDeletedanyOptional

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

Body

Responses

200

Project Resources

application/json

400

Invalid Input body.

application/json

post

HTTPcURLJavaScriptPython

POST /project/resource/v1/_search?limit=null&offset=null&tenantId=null HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 202

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "ProjectResource": {
    "id": [
      "text"
    ],
    "projectId": "text"
  }
}

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