Projects

API endpoints for project-related data mapping operations.

Create a New Project

post

This endpoint creates a new record representing a project in the data mapping system. For more details, refer to the Opsera API Documentation.

Use Cases

Project Management: Add new projects to your organizational hierarchy to ensure accurate mapping.
Data Integration: Facilitate integrations by maintaining an up-to-date project record system.
Audit and Compliance: Ensure that projects are properly tracked for auditing and compliance purposes.

Required Access

Authentication: Bearer token is required.
API Scope: api
Site Roles:
- Opsera Administrator
- Administrator
- Power User

Request Body Details

The request body must include the required attributes for the new project, which are validated before processing.

Required Fields:

projectId: The unique identifier for the project.
projectName: The name of the project.

Optional Fields:

assets: A project can represent one or more repositories and/or services
externalId: An external identifier Id for relating this person back to the original data source.
organization: The organization associated with the project. Represents the highest entity in the hierarchy.
business: The business unit for the project.
department: The department responsible for the project.
group: The group the project belongs to.
team: The team managing the project. Represents the lowest entity in the hierarchy.

Important Notes!
Mandatory Fields: Ensure projectId and projectName are included in the request body.
Optional Fields: Include externalId, assets, and other fields if applicable.
Attributes Object: Additional project details are encapsulated with the attributes object.

Authorizations

AuthorizationstringRequired

API authentication using Bearer tokens. Include your API token in the Authorization header: Authorization: Bearer <your-api-token>

Tokens can be obtained from the Opsera platform's API token management interface.

Body

projectIdstringRequired

Required. The unique identifier for the project.

Example: proj-123456

projectNamestringRequired

Required. The name of the project.

Example: New Web Application

externalIdstringOptional

External identifier for the project.

Example: abc123-def456-ghi789

organizationstringOptional

Organization associated with the project.

Example: Opsera

businessstringOptional

Business unit associated with the project.

Example: Engineering

departmentstringOptional

Department responsible for the project.

Example: Platform

groupstringOptional

Group the project belongs to.

Example: Development

teamstringOptional

Team managing the project.

Example: Backend Team

Responses

200

Project created successfully.

application/json

idstringOptional

Unique identifier for the created project.

Example: proj-123456

messagestringOptional

Success message.

Example: Project created successfully.

400

Bad Request - Invalid or missing data provided.

application/json

403

Forbidden - Access denied due to insufficient permissions.

application/json

500

Internal Server Error - An unexpected error occurred.

application/json

post

/api/v2/data/project

POST /api/v2/data/project HTTP/1.1
Host: api.[organization].opsera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 577

{
  "projectId": "proj-123456",
  "projectName": "New Web Application",
  "projectOwner": {
    "firstName": "Jane",
    "lastName": "Smith",
    "email": "[email protected]"
  },
  "externalId": "abc123-def456-ghi789",
  "organization": "Opsera",
  "business": "Engineering",
  "department": "Platform",
  "group": "Development",
  "team": "Backend Team",
  "assets": {
    "repositories": [
      {
        "name": "api-service",
        "platform": "github.com",
        "url": "https://github.com/Opsera/api-service.git"
      }
    ],
    "services": [
      {
        "name": "authentication-service",
        "identifier": "auth-svc-01",
        "dependencies": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "externalId": "svc-123456"
      }
    ]
  }
}

{
  "id": "proj-123456",
  "message": "Project created successfully."
}

List All Projects

get

This endpoint retrieves a list of all projects in the data mapping system. Each project record includes key attributes such as the associated organization, business unit, department, group, and team. For more details, refer to the Opsera API Documentation.

Use Cases

Project Overview: Obtain a comprehensive list of all projects in your organizational hierarchy.
Data Integration: Facilitate integrations by accessing up-to-date project records.
Audit and Compliance: Ensure all projects are accounted for during audits and compliance checks.

Required Access

Authentication: Bearer token is required.
API Scope: api

Authorizations

AuthorizationstringRequired

API authentication using Bearer tokens. Include your API token in the Authorization header: Authorization: Bearer <your-api-token>

Tokens can be obtained from the Opsera platform's API token management interface.

Responses

200

Successfully retrieved all projects.

application/json

countintegerOptional

Total number of projects retrieved.

Example: 10

400

Bad Request - Invalid or missing data provided.

application/json

403

Forbidden - Access denied due to insufficient permissions.

application/json

500

Internal Server Error - An unexpected error occurred.

application/json

get

/api/v2/data/projects

GET /api/v2/data/projects HTTP/1.1
Host: api.[organization].opsera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 10,
  "data": [
    {
      "id": "proj-2322345",
      "projectName": "Phase 2",
      "projectOwner": {
        "firstName": "John",
        "lastName": "Doe",
        "email": "[email protected]"
      },
      "externalId": "25ce97e1-549b-4f31-bd01-80490847f8a6",
      "organization": "Opsera",
      "business": "Engineering",
      "department": "Platform",
      "group": "Phase 2",
      "team": "AOD",
      "assets": {
        "repositories": [
          {
            "name": "web-portal",
            "platform": "github.com",
            "url": "https://github.com/Opsera/web-portal.git"
          }
        ],
        "services": [
          {
            "name": "ha-proxy",
            "identifier": "haprox01",
            "dependencies": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "externalId": "b558c4d4-1eba-45e8-92bb-b255df6abd87"
          }
        ]
      }
    }
  ]
}

Get a Specific Project

get

This endpoint retrieves detailed information about a specific project from the data mapping system using its unique identifier. For more details, refer to the Opsera API Documentation.

Use Cases

Project Details: Retrieve full details of a specific project for use in dashboards or integrations.
Data Validation: Verify project information as part of a workflow or audit.
System Integration: Access project details for organizational or hierarchical data integration.

Required Access

Authentication: Bearer token is required.
API Scope: api
Site Roles:
- Opsera Administrator
- Administrator
- Power User

Authorizations

AuthorizationstringRequired

API authentication using Bearer tokens. Include your API token in the Authorization header: Authorization: Bearer <your-api-token>

Tokens can be obtained from the Opsera platform's API token management interface.

Path parameters

projectIdstringRequired

The unique identifier of the project to retrieve.

Example: <project-id>

Responses

200

Successfully retrieved the project.

application/json

idstringOptional

Unique identifier for the project.

Example: <project-id>

projectNamestringOptional

Name of the project.

Example: Phase 2

externalIdstringOptional

External identifier for the project.

Example: <external-id>

organizationstringOptional

Organization associated with the project.

Example: Opsera

businessstringOptional

Business unit associated with the project.

Example: Engineering

departmentstringOptional

Department responsible for the project.

Example: Platform

groupstringOptional

Group the project belongs to.

Example: Phase 2

teamstringOptional

Team managing the project.

Example: AOD

404

Project not found.

application/json

500

Internal server error.

application/json

get

/api/v2/data/project/{projectId}

GET /api/v2/data/project/{projectId} HTTP/1.1
Host: api.[organization].opsera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "<project-id>",
  "projectName": "Phase 2",
  "projectOwner": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "[email protected]"
  },
  "externalId": "<external-id>",
  "organization": "Opsera",
  "business": "Engineering",
  "department": "Platform",
  "group": "Phase 2",
  "team": "AOD",
  "assets": {
    "repositories": [
      {
        "name": "web-portal",
        "platform": "github.com",
        "url": "https://github.com/example/web-portal.git"
      }
    ],
    "services": [
      {
        "name": "ha-proxy",
        "identifier": "haprox01",
        "dependencies": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "externalId": "<service-external-id>"
      }
    ]
  }
}

Update a Project

put

This endpoint updates an existing project in the data mapping system using the provided project ID. This endpoint allows users to modify project details such as organization, business unit, department, group, and team associations.

Use Cases

Project Maintenance: Keep project information up-to-date with the latest organizational changes.
Data Correction: Correct any inaccuracies in project records.
Integration Updates: Sync project changes across integrated systems.

Required Access

Authentication: Bearer token is required.
Permissions: User must have the appropriate roles and rights to update project records.

Process Details

Request Validation:
- Validates that the projectId parameter is provided and valid.
- Ensures the request body contains valid and properly formatted data.
Update Operation:
- Updates the project record with the provided information.
Audit Logging:
- Logs the update action for compliance and traceability.

Important Notes!
Ensure the projectId in the path matches the project you intend to update.
All fields are optional; include only the fields you wish to update.

Authorizations

AuthorizationstringRequired

API authentication using Bearer tokens. Include your API token in the Authorization header: Authorization: Bearer <your-api-token>

Tokens can be obtained from the Opsera platform's API token management interface.

Path parameters

projectIdstringRequired

The unique identifier of the project to update.

Example: <mapping-id>

Body

organizationstringOptional

Updated organization associated with the project.

Example: Opsera Inc.

businessstringOptional

Updated business unit for the project.

Example: Technology

departmentstringOptional

Updated department responsible for the project.

Example: Engineering

groupstringOptional

Updated group the project belongs to.

Example: Development Group

teamstringOptional

Updated team managing the project.

Example: Backend Team

Responses

200

Project updated successfully.

application/json

idstringOptional

Unique identifier for the project.

Example: <mapping-id>

organizationstringOptional

Organization associated with the project.

Example: Opsera Inc.

businessstringOptional

Business unit for the project.

Example: Technology

departmentstringOptional

Department responsible for the project.

Example: Engineering

groupstringOptional

Group the project belongs to.

Example: Development Group

teamstringOptional

Team managing the project.

Example: Backend Team

updatedAtstring · date-timeOptional

Timestamp of when the project was last updated.

Example: 2023-11-05T12:00:00.000Z

400

Bad request - Invalid or missing input data.

application/json

401

Unauthorized - Authentication failed or missing.

application/json

403

Forbidden - Access denied due to insufficient permissions.

application/json

404

Project not found.

application/json

500

Internal server error.

application/json

put

/api/v2/data/project/{projectId}

PUT /api/v2/data/project/{projectId} HTTP/1.1
Host: api.[organization].opsera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 131

{
  "organization": "Opsera Inc.",
  "business": "Technology",
  "department": "Engineering",
  "group": "Development Group",
  "team": "Backend Team"
}

{
  "id": "<mapping-id>",
  "organization": "Opsera Inc.",
  "business": "Technology",
  "department": "Engineering",
  "group": "Development Group",
  "team": "Backend Team",
  "updatedAt": "2023-11-05T12:00:00.000Z"
}

PreviousPipelines NextSearch

Last updated 4 days ago

Good morning

hashtagCreate a New Project

hashtagUse Cases

hashtagRequired Access

hashtagRequest Body Details

hashtagImportant Notes!

hashtagList All Projects

hashtagUse Cases

hashtagRequired Access

hashtagGet a Specific Project

hashtagUse Cases

hashtagRequired Access

hashtagUpdate a Project

hashtagUse Cases

hashtagRequired Access

hashtagProcess Details

hashtagImportant Notes!

Create a New Project

Use Cases

Required Access

Request Body Details

Important Notes!

List All Projects

Use Cases

Required Access

Get a Specific Project

Use Cases

Required Access

Update a Project

Use Cases

Required Access

Process Details

Important Notes!