Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

API Documentation

Introduction

This document provides detailed information on the external API endpoints for managing companies and projects. The API uses an API key for authentication, which should be generated through EVM settings.

...

Code Block
{
    "company_id*": 1,
    "name*": "New Project",
    "duration_format*": "hours|days",
    "money_format*": "default|thousands|millions",
    "start_date": "2024-07-01",
    "due_date": "2024-12-31",
    "jira_jql*": "project = TEST",
    "status*": "Proposal|Initiating|Planning|Ready to Start|Executing|On Hold|Blocked|QA Validation|QA Failed|PO / Client validation|Done|Canceled",
    “budget”: 10000,
    “reset_on_import”: true|false or 1|0,
    “ignore_time_entered_before_this_date”: true|false or 1|0,
    “description”: “New Project Description”,
    “notes”: “New Project Notes”
}

Response:

Code Block
201 Created:
{
    "data": {
        "id": 1,
        "companyId": 1,
        "name": "New Project",
        "durationFormat": "days",
        "moneyFormat": "default",
        "startDate": "2024-07-01",
        "dueDate": "2024-12-31",
        "jiraJql": "project = TEST",
        "status": 4,
	   “statueName”"statueName”: “Executing”,
        “budget”: 10000,
        “reset_on_import”: false,
        “ignore_time_entered_before_this_date”: false,
        “description”: “New Project Description”,
        “notes”: “New Project Notes”
    }
}

Error Responses:

  • 400 Bad Request: If the request data is invalid.

  • 403 Forbidden: If the API key is invalid or does not have the necessary permissions.