Amgen Portal API

# Document Categories

The Document Categories API allows for CRUD operations on document category records, providing essential fields like category_name and category_description.

# Get Document Category List

Retrieve a list of all document categories.

  • URL: documents/document-categories/
  • Method: GET
  • Response Example:
    [
  {
    "unique_id": "cat123",
    "category_name": "Finance",
    "category_description": "Category for financial documents",
    "date_created": "2023-01-01T12:00:00Z",
    "last_updated": "2023-01-01T12:00:00Z"
  },
  {
    "unique_id": "cat456",
    "category_name": "Healthcare",
    "category_description": "Category for healthcare-related documents",
    "date_created": "2023-01-02T12:00:00Z",
    "last_updated": "2023-01-02T12:00:00Z"
  },
  ...
]

# Create a Document Category

Create a new document category.

  • URL: documents/document-categories/
  • Method: POST
  • Request Example:
    {
  "category_name": "Finance",
  "category_description": "Category for financial documents"
}
  • Response Example:
    {
  "unique_id": "cat123",
  "category_name": "Finance",
  "category_description": "Category for financial documents",
  "date_created": "2023-01-01T12:00:00Z",
  "last_updated": "2023-01-01T12:00:00Z"
}

# Get a Document Category

Retrieve details of a specific document category by unique ID.

  • URL: documents/document-categories/<str:unique_id>/
  • Method: GET
  • Response Example:
    {
  "unique_id": "cat123",
  "category_name": "Finance",
  "category_description": "Category for financial documents",
  "date_created": "2023-01-01T12:00:00Z",
  "last_updated": "2023-01-01T12:00:00Z"
}

# Update a Document Category

Update an existing document category by unique ID.

  • URL: documents/document-categories/<str:unique_id>/
  • Method: PUT
  • Request Example:
    {
  "category_name": "Corporate Finance",
  "category_description": "Category for corporate finance documents"
}
  • Response Example:
    {
  "unique_id": "cat123",
  "category_name": "Corporate Finance",
  "category_description": "Category for corporate finance documents",
  "date_created": "2023-01-01T12:00:00Z",
  "last_updated": "2023-01-03T08:30:00Z"
}

# Delete a Document Category

Delete a document category by unique ID.

  • URL: documents/document-categories/<str:unique_id>/
  • Method: DELETE
  • Response: 204 No Content

← Documents →