Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Project Management

Create Project Object

Use this API to create a new Project object record.

🗒 Things to Know

  • This API only supports creating Project objects via Object Manager.
post/api/custom-entity/v1/projects

Request body

namestring required

The name of the object.

descriptionstring

The description of the object.

deadlinestring date

The deadline of the project.

externalIdstring

The external identifier for the project.

projectLinkstring uri

The project link or other URL.

intendedUsestring

The intended use of the project.

businessValuestring

The business value of the project.

projectOwnerstring

The user assigned as the owner of the project.

status'Draft' | 'Active' | 'In Progress' | 'On Hold' | 'Completed' | 'Cancelled'

The status of the project.

type'AI' | 'Campaign' | 'Feature' | 'General' | 'Process' | 'Product'

The type of project.

internalOrExternal'Internal' | 'External'

This parameter indicates whether the project is internal or external.

promotionStatus'Not Promoted' | 'Promoted' | 'Promotion Pending'

The project promotion status.

additionalAttributesobject

This parameter can be used to store attribute details in key value pairs.

Example request

{
  "name": "Data Analytics Platform Development",
  "description": "Development of an enterprise-wide data analytics platform",
  "deadline": "2025-12-31",
  "externalId": "PROJ-2025-001",
  "projectLink": "https://project-tracker.example.com/projects/PROJ-2025-001",
  "status": "Active",
  "type": "Development"
}

Response

Project entity created successfully

idstring uuid required

The unique identifier of the entity.

numberinteger required

The numerical order in which the entity was created.

namestring

The name of the entity.

orgGroupIdstring uuid

The unique identifier of the organization.

schemaIdstring uuid required

The unique identifier of the schema.

attributesobject

Example response

{
  "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
  "number": 1,
  "name": "OneTrust",
  "orgGroupId": "d1119953-b4b5-4042-8cb9-b78038cc2c46",
  "entityType": {
    "id": "a2319953-b4b5-4042-8cb9-b78038cc4c46",
    "name": "Asset"
  },
  "workflowAndStage": {
    "id": "b271c01a-89a9-41b1-8185-0a3e2bfdad84",
    "name": "Vendor On-Boarding Workflow",
    "type": "Vendor",
    "workflowMode": "BASIC",
    "stageId": "9fc111cb-c379-4f08-8aff-5be954c1a6e6",
    "stageName": "Start On-Boarding"
  },
  "attributes": {
    "textAttributeName": [
      {
        "value": "Text"
      }
    ],
    "optionBasedAttributeName": [
      {
        "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46"
      }
    ]
  },
  "auditFields": {
    "createdBy": {
      "id": "c21319953-b4b5-4042-8cb9-b78038cc4c51",
      "name": "Name"
    },
    "lastModifiedBy": {
      "id": "c21319953-b4b5-4042-8cb9-b78038cc4c51",
      "name": "Name"
    }
  }
}