Uploading Planning Data

Upload Example Using cURL

In the following, we provide an example of how to push your Planning data to Logilica for storage and built-in analytics. The following depicts all possible fields that can be included in an upload of a ticket or issue, both the mandatory and optional fields.

The cURL POST command is below. Note, the POST command includes the example API token lgca_UeRxFs_3RYRJEJtdYp7j7Wa6DirG5NjiYslsb and the example workspace myworkspace. The command URL also includes a placeholder for the projectID to associate the uploaded issues with. This projectID is obtained from the pm/projects/create endpoint.

curl --location --request POST \
'https://logilica.io/api/import/v1/pm/<projectID>/issues/create' \
--header 'X-lgca-token: lgca_UeRxFs_3RYRJEJtdYp7j7Wa6DirG5NjiYslsb' \
--header 'x-lgca-domain: myworkspace' \
--header 'Content-Type: application/json' \
--data-raw '[{
    "id": "ABC-123",
    "origin": "JIRA",
    "createdAt": 1689207410,
    "updatedAt": 1689309835,
    "creator": {
        "name": "John Doe",
        "email": "[e-mail]",
        "accountId": "johnDoe",
        "lastActivity": 1701436893
    },
    "reporter": {
        "name": "Jane Doe",
        "email": "[e-mail]",
        "accountId": "janeDoe",
        "lastActivity": 1699536093
    },
    "assignedAt": 1689207463,
    "assignee": {
        "name": "Sally Smith",
        "email": "[e-mail]",
        "accountId": "sallySmith",
        "lastActivity": 1701091293
    },
    "inProgressAt": 1689207487,
    "resolvedAt": 1689309835,
    "resolver": {
        "name": "Sally Smith",
        "email": "[e-mail]",
        "accountId": "sallySmith",
        "lastActivity": 1701436893
    },
    "resolution": "Fix",
    "type": "Task",
    "status": "Completed",
    "statusCategory": "Done",
    "summary": "Revive user API endpoints in each service.",
    "description": "Go into each service and enable the API endpoints that both upload and import user data.",
    "url": "https://myworkspacename.atlassian.net/browse/ABC-123",
    "labels": ["backend"],
    "sprintKeys": ["456"],
    "priority": "Low",
    "storyPointEstimate": 1,
    "parentIssue": "ABC-789",
    "events": [
        {
            "type": "PM_ISSUE_CREATED",
            "author": {
                "name": "John Doe",
                "email": "[e-mail]",
                "accountId": "johnDoe",
                "lastActivity": 1701436893
            },
            "createdAt": 1689207410,
            "to": ""
        },
        {
            "type": "PM_ISSUE_ASSIGNED",
            "author": {
                "name": "John Doe",
                "email": "[e-mail]",
                "accountId": "johnDoe",
                "lastActivity": 1701436893
            },
            "createdAt": 1689207463,
            "to": {
                "name": "Sally Smith",
                "email": "[e-mail]",
                "accountId": "sallySmith",
                "lastActivity": 1701091293
            }
        },
        {
            "type": "PM_ISSUE_IN_PROGRESS",
            "author": {
               "name": "Sally Smith",
                "email": "[e-mail]",
                "accountId": "sallySmith",
                "lastActivity": 1701091293
            },
            "createdAt": 1689207487,
            "from": "To Do",
            "to": "In Progress"
        },
        {
            "type": "PM_ISSUE_RESOLVED",
            "author": {
               "name": "Sally Smith",
                "email": "[e-mail]",
                "accountId": "sallySmith",
                "lastActivity": 1701091293
            },
            "createdAt": 1689309835,
            "from": "In Progress",
            "to": "Done"
        }
    ]
}]'

Method of Importing Planning Data

In order to ensure accuracy of data in Logilica, planning data should be imported in the following order:

1. Create a project and fetch the ID returned to you. You use this ID in subsequent calls to the Logilica Import API for Planning Data.

2. Import or update sprints

3. Import or update issues

Data is displayed in Logilica once issues have been imported.

API Schema for Importing Planning Data

Create a new project

Add a new project

POSThttps://logilica.io/api/import/v1/pm/projects/create

Body

application/json

URL*string (uri)

The URL by which this project may be reached in a browser

key*string

For Jira style projects, this maps the the issue prefix, eg in "JIRA-123", key would be "JIRA". For gitlab projects, this is the ID of the project.

orgName*string

The name of organization / group to which the project belongs. orgName combined with key forms a unique identifier for the project.

Response

200400401

The ID of the newly created project

Body

application/json

id*string

The internal ID of the newly created project

Request

JavaScriptCurl

const response = await fetch('https://logilica.io/api/import/v1/pm/projects/create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "URL": "https://example.com",
      "key": "text",
      "orgName": "text"
    }),
});
const data = await response.json();

Response

{
  "id": "text"
}

Add or Update Sprints

Add or update a list of sprints

POSThttps://logilica.io/api/import/v1/pm/{projectID}/sprints

Path parameters

projectID*string

Body

application/json

id*string

unique (per board) ID of sprint

name*string

name of sprint

state*string

current state, e.g. "closed" or "in progress"

goal*string

sprint goal or description

startedAtnumber

UNIX timestamp for when sprint started

endedAtnumber

UNIX timestamp for when sprint is set to ended

completedAtnumber

UNIX timestamp for when the sprint was finished

Response

200400401404

Empty

Request

JavaScriptCurl

const response = await fetch('https://logilica.io/api/import/v1/pm/{projectID}/sprints', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "name": "text",
        "state": "text",
        "goal": "text"
      }
    ]),
});
const data = await response.json();

Add or Update Issues

Create or update an issue

POSThttps://logilica.io/api/import/v1/pm/{projectID}/issues/create

Path parameters

projectID*string

Body

application/json

id*string

unique global ID of issue

origin*string

tool where the issue is from (e.g. Jira)

updatedAt*number

UNIX timestamp of the last update to the issue

createdAt*number

UNIX timestamp of when issue was created

creator*object

Details of person who created the issue

reporter*object

Details of person who reported the issue

assignedAtnumber

UNIX timestamp of when issue was last assigned

assigneeobject

Details of the person assignee to the issue

inProgressAtnumber

UNIX timestamp of when issue was moved to In Progress

resolvedAtnumber

UNIX timestamp of when issue was moved to Done

resolverobject

Details of the person who resolved the issue

resolutionstring

The kind of resolution, e.g. "Fix", "Ignored"

type*string

Issue type (Bug, Task, Subtask, Story, Epic). Subtasks and Epics are treated specially.

status*string

Issue status

statusCategory*string

Issue status category (one of "To Do", "In Progress", "Done")

summary*string

Issue title

description*string

Issue description

url*string (uri)

URL to issue

labels*array of string

Any labels applied to issue

sprintKeys*array of string

IDs of sprints the issue belongs to

priority*string

Priority of issue

storyPointEstimate*number

Story point estimate

parentIssuestring

When the issue is part of an epic, the ID of that epic

events*array of object

List of events that have happened to the issue, in chronological order Note: this must include at least a CREATED event. Other events such as Change Sprint are required for metrics such as sprint overrun

Response

200400401404

Success - if any sprintIDs were referenced in the dataset, warnings will be given.

Body

application/json

warningsobject

Request

JavaScriptCurl

const response = await fetch('https://logilica.io/api/import/v1/pm/{projectID}/issues/create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "origin": "text",
        "updatedAt": 0,
        "createdAt": 0,
        "creator": {
          "name": "text",
          "accountId": "text",
          "lastActivity": 0
        },
        "reporter": {
          "name": "text",
          "accountId": "text",
          "lastActivity": 0
        },
        "type": "text",
        "status": "text",
        "statusCategory": "text",
        "summary": "text",
        "description": "text",
        "url": "https://example.com",
        "labels": [
          "text"
        ],
        "sprintKeys": [
          "text"
        ],
        "priority": "text",
        "storyPointEstimate": 0,
        "events": [
          {
            "createdAt": 0,
            "author": {
              "name": "text",
              "accountId": "text",
              "lastActivity": 0
            },
            "type": "PM_ISSUE_CREATED",
            "to": "text"
          }
        ]
      }
    ]),
});
const data = await response.json();

Response

{
  "warnings": {
    "message": "text",
    "ids": [
      "text"
    ]
  }
}