Activity

An activity.

Create an activity

Create a new activity for a measure.

SecurityJWT
Request
Request Body schema: application/json

A JSON object containing activity information.

name
required
string <= 1000 characters

The name of the activity.

description
string <= 50000 characters

The description of the activity.

start_time_plan
string or null <date>

The start time plan of the activity.

The date must be before or equal to the end time plan. It must match one of the following formats:

  • Y-m-d
  • Y/m/d
  • d.m.Y
  • m/d/Y

start_time_actual
string or null <date>

The start time actual of the activity.

The date must be before or equal to the end time actual. It must match one of the following formats:

  • Y-m-d
  • Y/m/d
  • d.m.Y
  • m/d/Y

end_time_plan
string or null <date>

The end time plan of the activity.

The date must be after or equal to the start time plan. It must match one of the following formats:

  • Y-m-d
  • Y/m/d
  • d.m.Y
  • m/d/Y

end_time_actual
string or null <date>

The end time actual of the activity.

The date must be after or equal to the start time actual. It must match one of the following formats:

  • Y-m-d
  • Y/m/d
  • d.m.Y
  • m/d/Y

measure
required
string or integer

The measure of the activity.

Without a measure the request will always return a 403 Forbidden response.

responsible_user
string or integer or null >= 1

The responsible user of the activity.

Responses
201

Successful operation

422

Unprocessable Content

post/activity
Request samples
application/json
{
  • "name": "ABC analysis",
  • "description": "ABC analysis",
  • "start_time_actual": "2022-04-20",
  • "end_time_actual": "2022-04-20",
  • "responsible_user": 1,
  • "measure": "2b896ac5921a961005948362c363f0fa40a65c95"
}
Response samples
application/json
{
  • "success": true,
  • "hash": "9dd51a0ea5f6b7eb901bd5d997fce6e14e2a1879",
  • "data": {
    },
  • "timestamp": 1654787515394
}

Get all activities

Get all activities of the authenticated hub.

Since there are different maximum lengths for URLs in different browsers, there is also a filter route that can work with an unlimited number of body parameters as an alternative to this index route. The filter route accepts the same parameters and returns the same response as this index route.

SecurityJWT
Request
query Parameters
measure
string or integer

Filter the activity list for a measure.

measure_package
string or integer

Filter the activity list for a measure package.

project
string or integer

Filter the activity list for a project.

program
string or integer

Filter the activity list for a program.

tags
Array of strings or integers

Filter the activity list for measure tags.

workflow_phases
Array of strings or integers

Filter the activity list for measure workflow phases.

responsible_users
Array of strings or integers

Filter the activity list for measure responsible users.

paused
boolean

Filter the activity list for paused activities.

locked
boolean

Filter the activity list for locked activities.

status
integer

Filter the activity list for a schedule status.

  • 0 - Open
  • 1 - Running
  • 2 - Finished
Enum: 0 1 2
umask
integer

Filter the activity list for the minimum permission of the authenticated user.

  • 2 - Write
  • 3 - Admin
  • 4 - Owner
Enum: 2 3 4
responsible_user
string or integer

Filter the activity list for a responsible user.

created_user
string or integer

Filter the activity list for a created user.

modified_user
string or integer

Filter the activity list for a modified user.

page
integer
Default: 1

The page number of the response.

Responses
200

Successful operation

422

Unprocessable Content

get/activity
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "hash": "0da942a96ab5944a087aaf09266e2d6d91c0740b",
  • "data": [
    ],
  • "meta": {
    },
  • "timestamp": 1654265060983
}
Get an activity
Get an activity.


SecurityJWT 
Request 
path Parameters
activity
required
string or integer
The id/hash of the activity.


 
Responses 
200
Successful operation


404
Not Found


get/activity/{activity}
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "hash": "0da942a96ab5944a087aaf09266e2d6d91c0740b",
  • "data": {
    },
  • "timestamp": 1654265060983
}
Update an activity
Update an activity.


SecurityJWT 
Request 
path Parameters
activity
required
string or integer
The id/hash of the activity.


 
Request Body schema: application/json
A JSON object containing activity information


name
string  <= 1000 characters 
The activity name.


 
description
string  <= 50000 characters 
The activity description.


 
start_time_plan
string or null <date> 
The activity start time plan.
The date must be before or equal to the end time plan. It must match one of the following formats:
  • Y-m-d
  • Y/m/d
  • d.m.Y
  • m/d/Y
 
start_time_actual
string or null or string or null <date> 
The activity start time actual.
The date must be before or equal to the end time actual. It must match one of the following formats:
  • Y-m-d
  • Y/m/d
  • d.m.Y
  • m/d/Y
 
end_time_plan
string or null <date> 
The activity end time plan.
The date must be after or equal to the start time plan. It must match one of the following formats:
  • Y-m-d
  • Y/m/d
  • d.m.Y
  • m/d/Y
 
end_time_actual
string or null <date> 
The activity end time actual.
The date must be after or equal to the start time actual. It must match one of the following formats:
  • Y-m-d
  • Y/m/d
  • d.m.Y
  • m/d/Y
 
started
boolean
The started flag for the activity.
The flag overwrites the start time actual of the activity if it is not within the start time tolerance of the schedule.
 
finished
boolean
The finished flag for the activity.
The flag overwrites the end time actual of the activity if it is not within the end time tolerance of the schedule.
 
responsible_user
string or integer or null  >= 1 
The activity responsible user.


 
Responses 
200
Successful operation


404
Not Found


422
Unprocessable Content


put/activity/{activity}
Request samples 
application/json
{
  • "description": "Determine the value of inventory items based on their importance to the business.",
  • "start_time_plan": "2022-05-19",
  • "end_time_actual": "2022-05-21",
  • "started": true,
  • "responsible_user": 1
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "6a80ae1e9b6528d8d722341ed3529e2ac863e3a7",
  • "data": {
    },
  • "timestamp": 1653466096096
}
Delete an activity
Delete an activity.


SecurityJWT 
Request 
path Parameters
activity
required
string or integer
The id/hash of the activity.


 
Responses 
200
Successful operation


404
Not Found


delete/activity/{activity}
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1655826069080
}
Copy an activity
Copy an activity into a measure.


SecurityJWT 
Request 
path Parameters
activity
required
string or integer
The id/hash of the activity.


 
Request Body schema: application/json
A JSON object containing activity information.


measure
required
string or integer
The new parent measure of the activity.
Without a measure the request will always return a 403 Forbidden response.
 
Responses 
200
Successful operation


404
Not Found


post/activity/{activity}/copy
Request samples 
application/json
{
  • "measure": "2b896ac5921a961005948362c363f0fa40a65c95"
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1648482064495
}
Freeze an activity
Freeze an activity.


SecurityJWT 
Request 
path Parameters
activity
required
string or integer
The id/hash of the activity.


 
Request Body schema: application/json
A JSON object containing activity information.


locked
boolean
 Default:  true
The locked flag for the activity.


 
Responses 
200
Successful operation


404
Not Found


put/activity/{activity}/freeze
Request samples 
application/json
{
  • "locked": true
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "6a80ae1e9b6528d8d722341ed3529e2ac863e3a7",
  • "data": {
    },
  • "timestamp": 1655901316497
}
Pause an activity
Pause an activity.


SecurityJWT 
Request 
path Parameters
activity
required
string or integer
The id/hash of the activity.


 
Request Body schema: application/json
A JSON object containing activity information.


paused
boolean
 Default:  true
The paused flag for the activity.


 
Responses 
200
Successful operation


404
Not Found


put/activity/{activity}/pause
Request samples 
application/json
{
  • "paused": true
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "6a80ae1e9b6528d8d722341ed3529e2ac863e3a7",
  • "data": {
    },
  • "timestamp": 1655901316497
}
Position an activity
Position an activity in relation to another activity.


SecurityJWT 
Request 
path Parameters
activity
required
string or integer
The id/hash of the activity.


 
Request Body schema: application/json
A JSON object containing activity information.


position
required
string
The position in relation to the activity.


 Enum: "before" "after"  
activity
required
string or integer
The activity to position the given activity to.
Both activities must belong to the same measure.
 
Responses 
200
Successful operation


404
Not Found


422
Unprocessable Content


put/activity/{activity}/position
Request samples 
application/json
{
  • "position": "before",
  • "activity": 653
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "192dab761e17a782da25ec5a2de4dfdc48c650f3",
  • "data": {
    },
  • "timestamp": 1655976061248
}
Relocate an activity
Relocate an activity to a new parent measure.


SecurityJWT 
Request 
path Parameters
activity
required
string or integer
The id/hash of the activity.


 
Request Body schema: application/json
A JSON object containing activity information.


measure
required
string or integer
The new parent measure of the activity.
Without a measure the request will always return a 403 Forbidden response.
 
Responses 
200
Successful operation


404
Not Found


put/activity/{activity}/relocate
Request samples 
application/json
{
  • "measure": "2b896ac5921a961005948362c363f0fa40a65c95"
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "6a80ae1e9b6528d8d722341ed3529e2ac863e3a7",
  • "data": {
    },
  • "timestamp": 1653466096096
}
Restore an activity
Restore an activity.


SecurityJWT 
Request 
path Parameters
activity
required
string or integer
The id/hash of the activity.


 
Responses 
200
Successful operation


404
Not Found


put/activity/{activity}/restore
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1655979462387
}
Transform an activity
Transform an activity to a measure.
The activity attributes name and description as well as the flags paused, locked and guarded are transferred to the new measure. The responsible user of the activity is also adopted.
The activity will be deleted afterwards, but can be restored from the trash.
SecurityJWT 
Request 
path Parameters
activity
required
string or integer
The id/hash of the activity.


 
Request Body schema: application/json
A JSON object containing activity information.


measure_package
required
string or integer
The parent measure package in which the new measure will be created.
Without a measure package the request will always return a 403 Forbidden response.
 
Responses 
200
Successful operation


404
Not Found


put/activity/{activity}/transform
Request samples 
application/json
{
  • "measure_package": "f4aeaa8ed7cad113feec00b0954963f69505051f"
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1681314604814
}
Set plan for an activity
Replace the actual time values with the plan time values for an activity.


SecurityJWT 
Request 
path Parameters
activity
required
string or integer
The id/hash of the activity.


 
Responses 
200
Successful operation


404
Not Found


put/activity/{activity}/plan
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "hash": "7096edd5cbd202f58e15ee673b91925be6c98023",
  • "data": {
    },
  • "timestamp": 1654620724137
}
Set actual for an activity
Replace the plan time values with the actual time values for an activity.


SecurityJWT 
Request 
path Parameters
activity
required
string or integer
The id/hash of the activity.


 
Responses 
200
Successful operation


404
Not Found


put/activity/{activity}/actual
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "hash": "7096edd5cbd202f58e15ee673b91925be6c98023",
  • "data": {
    },
  • "timestamp": 1654620383765
}
Filter all activities
Alternative to the index route, since there are different maximum lengths for URLs in different browsers. The filter route accepts the same parameters and returns the same response as the index route.


SecurityJWT 
post/activity/filter
Request samples 
➔ Next to Attachment