Update Project#

You can update a project through the NeMo Entity Store microservice to change details such as its description or custom fields.

Prerequisites#

Before you can update a project, make sure that you have:

  • Obtained the base URL of your NeMo Entity Store Microservice.

  • Permissions to access the NeMo Entity Store microservice endpoint.

  • Obtained the namespace and project_name of the project you want to update.

How to Update a Project#

API#

  1. Make a PATCH request to the /v1/projects/{namespace}/{project_name} endpoint.

    export ENTITY_STORE_BASE_URL=<URL for NeMo Entity Store>
export NAMESPACE="docs"
export PROJECT_NAME="Documentation Test Project"

# URL-encode the project name if necessary.
ENCODED_PROJECT_NAME=$(printf %s "$PROJECT_NAME" | jq -sRr @uri)

curl -X PATCH "${ENTITY_STORE_BASE_URL}/v1/projects/${NAMESPACE}/${ENCODED_PROJECT_NAME}" \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -d '{
    "custom_fields": {
        "team": "documentation",
        "priority": "high",
        "status": "completed",
        "target_completion": "2025-03-31"
    }
    }' | jq

  2. Verify that the project was updated by reviewing the response.

    Example Response
    {
  "schema_version": "1.0",
  "id": "project-RM4tayGfUwA1aqu5NfTDA1",
  "description": "A project for documentation testing",
  "type_prefix": null,
  "namespace": "docs",
  "project": null,
  "created_at": "2025-02-12T17:00:33.795767",
  "updated_at": "2025-02-12T17:00:33.795769",
  "custom_fields": {
    "team": "documentation",
    "priority": "high",
    "status": "completed",
    "target_completion": "2024-03-31"
  },
  "ownership": {
    "created_by": "user@nvidia.com",
    "access_policies": {}
  },
  "name": "Documentation Test Project"
}