Activity

An activity.

Create an activity

Create a new activity for a given measure.

SecurityJWT
Request
Request Body schema: application/json

A JSON object containing activity information.

name
required
string <= 1000 characters

The name of the new activity.

description
string <= 35000 characters

The description of the new activity.

start_time_plan
string or null <date> Y-m-d, Y/m/d, d.m.Y, m/d/Y

The start time plan of the new activity. The date must be before or equal to the end time plan.

start_time_actual_specified
string or null <date> Y-m-d, Y/m/d, d.m.Y, m/d/Y

The start time actual of the new activity. The date must be before or equal to the end time actual specified.

end_time_plan
string or null <date> Y-m-d, Y/m/d, d.m.Y, m/d/Y

The end time plan of the new activity. The date must be after or equal to the start time plan.

end_time_actual_specified
string or null <date> Y-m-d, Y/m/d, d.m.Y, m/d/Y

The end time actual of the new activity. The date must be after or equal to the start time actual specified.

measure_hash
required
string

The measure for the new activity.

responsible_user_id
integer or null >= 1

The responsible user of the new activity.

Responses
201

Successful operation

401

Unauthorized

404

Not Found

422

Unprocessable Content

post/activity
Request samples
application/json
{
  • "name": "ABC analysis",
  • "description": "ABC analysis",
  • "start_time_actual_specified": "2022-04-20",
  • "end_time_actual_specified": "2022-04-20",
  • "responsible_user_id": 1,
  • "measure_hash": "2b896ac5921a961005948362c363f0fa40a65c95"
}
Response samples
application/json
{
  • "value": {
    }
}

Get all activities

Get all activities for the hub.

SecurityJWT
Request
query Parameters
measure_hash
string

Filter the activity list for a measure.

measure_package_hash
string

Filter the activity list for a measure package.

project_hash
string

Filter the activity list for a project.

program_hash
string

Filter the activity list for a program.

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 an umask.

  • 3 - Write
  • 4 - Admin
  • 5 - Owner
Enum: 0 1 2
involved_user_id
integer >= 1

Filter the activity list for an involved user.

responsible_user_id
integer >= 1

Filter the activity list for a responsible user.

Responses
200

Successful operation

401

Unauthorized

404

Not Found

get/activity
Request samples
curl -i -X GET \
  'https://api.nordan.tech/v1/activity?measure_hash=string&measure_package_hash=string&project_hash=string&program_hash=string&paused=true&locked=true&status=0&umask=0&involved_user_id=1&responsible_user_id=1' \
  -H 'Authorization: Bearer <YOUR_Bearer <TOKEN>_HERE>'
Response samples
application/json
{
  • "value": {
    }
}

Get an activity

Get an activity.

SecurityJWT
Request
path Parameters
activity
required
string

The id/hash of the current activity.

Responses
200

Successful operation

401

Unauthorized

403

Forbidden

404

Not Found

get/activity/{activity}
Request samples
curl -i -X GET \
  'https://api.nordan.tech/v1/activity/{activity}' \
  -H 'Authorization: Bearer <YOUR_Bearer <TOKEN>_HERE>'
Response samples
application/json
{
  • "value": {
    }
}

Update an activity

Update an activity

SecurityJWT
Request
path Parameters
activity
required
string

The id/hash of the current activity.

Request Body schema: application/json

A JSON object containing activity information

name
string <= 1000 characters

The activity name.

description
string <= 35000 characters

The activity description.

start_time_plan
string or null <date> Y-m-d, Y/m/d, d.m.Y, m/d/Y

The activity start time plan. The date must be before or equal to the end time plan.

start_time_actual_specified
string or null <date> Y-m-d, Y/m/d, d.m.Y, m/d/Y

The activity start time actual. The date must be before or equal to the end time actual specified.

end_time_plan
string or null <date> Y-m-d, Y/m/d, d.m.Y, m/d/Y

The activity end time plan. The date must be after or equal to the start time plan.

end_time_actual_specified
string or null <date> Y-m-d, Y/m/d, d.m.Y, m/d/Y

The activity end time actual. The date must be after or equal to the start time actual specified.

started
boolean

The activity started flag.

finished
boolean

The activity finished flag.

responsible_user_id
integer or null >= 1

The activity responsible user id.

hash
string

The hash of the activity.

Responses
200

Successful operation

401

Unauthorized

403

Forbidden

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.",
  • "end_time_actual_specified": "2022-05-21",
  • "started": true,
  • "responsible_user_id": 1,
  • "hash": "24a81426f8a5cf23ccd7e51288ed89cd2ebdbc1c"
}
Response samples
application/json
{
  • "value": {
    }
}

Delete an activity

Delete an activity

SecurityJWT
Request
path Parameters
activity
required
string

The id/hash of the current activity.

Responses
200

Successful operation

401

Unauthorized

403

Forbidden

404

Not Found

delete/activity/{activity}
Request samples
curl -i -X DELETE \
  'https://api.nordan.tech/v1/activity/{activity}' \
  -H 'Authorization: Bearer <YOUR_Bearer <TOKEN>_HERE>'
Response samples
application/json
{
  • "success": true,
  • "hash": "string",
  • "data": [ ],
  • "timestamp": 0
}

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

The id/hash of the current activity.

Responses
200

Successful operation

401

Unauthorized

403

Forbidden

404

Not Found

put/activity/{activity}/actual
Request samples
curl -i -X PUT \
  'https://api.nordan.tech/v1/activity/{activity}/actual' \
  -H 'Authorization: Bearer <YOUR_Bearer <TOKEN>_HERE>'
Response samples
application/json
{
  • "value": {
    }
}

Copy an activity

Copy an activity to a new measure.

SecurityJWT
Request
path Parameters
activity
required
string

The id/hash of the current activity.

Request Body schema: application/json

A JSON object containing activity information.

measure_hash
required
string

The hash of the new measure.

Responses
200

Successful operation

401

Unauthorized

403

Forbidden

404

Not Found

post/activity/{activity}/copy
Request samples
application/json
{
  • "measure_hash": "string"
}
Response samples
application/json
{
  • "value": {
    }
}

Freeze an activity

Freeze an activity.

SecurityJWT
Request
path Parameters
activity
required
string

The id/hash of the current activity.

Request Body schema: application/json

A JSON object containing activity information.

locked
boolean
Default: true

The locked flag for an activity.

Responses
200

Successful operation

401

Unauthorized

403

Forbidden

404

Not Found

put/activity/{activity}/freeze
Request samples
application/json
{
  • "locked": true
}
Response samples
application/json
{
  • "success": true,
  • "hash": "string",
  • "data": {
    },
  • "timestamp": 0
}

Pause an activity

Pause an activity.

SecurityJWT
Request
path Parameters
activity
required
string

The id/hash of the current activity.

Request Body schema: application/json

A JSON object containing activity information.

paused
boolean
Default: true

The paused flag for an activity.

Responses
200

Successful operation

401

Unauthorized

403

Forbidden

404

Not Found

put/activity/{activity}/pause
Request samples
application/json
{
  • "paused": true
}
Response samples
application/json
{
  • "success": true,
  • "hash": "string",
  • "data": {
    },
  • "timestamp": 0
}

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

The id/hash of the current activity.

Responses
200

Successful operation

401

Unauthorized

403

Forbidden

404

Not Found

put/activity/{activity}/plan
Request samples
curl -i -X PUT \
  'https://api.nordan.tech/v1/activity/{activity}/plan' \
  -H 'Authorization: Bearer <YOUR_Bearer <TOKEN>_HERE>'
Response samples
application/json
{
  • "value": {
    }
}

Position an activity

Position an activity in relation to another activity.

SecurityJWT
Request
path Parameters
activity
required
string

The id/hash of the current activity.

Request Body schema: application/json

A JSON object containing activity information.

position
required
string

The new position in relation to the activity.

Enum: "before" "after"
activity_id
required
integer

The activity to position an activity to.

Responses
200

Successful operation

401

Unauthorized

403

Forbidden

404

Not Found

put/activity/{activity}/position
Request samples
application/json
{
  • "position": "before",
  • "activity_id": 0
}
Response samples
application/json
{
  • "success": true,
  • "hash": "string",
  • "data": {
    },
  • "timestamp": 0
}

Relocate an activity

Relocate an activity to a new measure.

SecurityJWT
Request
path Parameters
activity
required
string

The id/hash of the current activity.

Request Body schema: application/json

A JSON object containing activity information.

measure_hash
required
string

The hash of the new measure.

Responses
200

Successful operation

401

Unauthorized

403

Forbidden

404

Not Found

put/activity/{activity}/relocate
Request samples
application/json
{
  • "measure_hash": "string"
}
Response samples
application/json
{
  • "success": true,
  • "hash": "string",
  • "data": {
    },
  • "timestamp": 0
}

Restore an activity

Restore an activity.

SecurityJWT
Request
path Parameters
activity
required
string

The id/hash of the current activity.

Responses
200

Successful operation

401

Unauthorized

403

Forbidden

404

Not Found

put/activity/{activity}/restore
Request samples
curl -i -X PUT \
  'https://api.nordan.tech/v1/activity/{activity}/restore' \
  -H 'Authorization: Bearer <YOUR_Bearer <TOKEN>_HERE>'
Response samples
application/json
{
  • "success": true,
  • "hash": "string",
  • "data": [ ],
  • "timestamp": 0
}

Transform an activity

Transform an activity to a measure.

SecurityJWT
Request
path Parameters
activity
required
string

The id/hash of the current activity.

Request Body schema: application/json

A JSON object containing activity information.

measure_package_hash
required
string

The measure package to transform the measure to.

Responses
200

Successful operation

401

Unauthorized

403

Forbidden

404

Not Found

put/activity/{activity}/transform
Request samples
application/json
{
  • "measure_package_hash": "string"
}
Response samples
application/json
{
  • "success": true,
  • "hash": "string",
  • "data": {
    },
  • "timestamp": 0
}