Skip to content

Creates and publishes the Tasks time/results report or dashboard once, together with its Runtime Menu item.

POST
/api/workspace/admin/tasks/reporting/{kind}
curl --request POST \
--url https://example.com/api/workspace/admin/tasks/reporting/0 \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "Title": "example", "RoleIds": [ "example" ], "UserIds": [ "example" ], "RuntimeMenuId": "example" }'
kind
required

The two independently generated, customer-editable Reporting definitions.

integer format: int32
Allowed values: 0 1

The two independently generated, customer-editable Reporting definitions.

access_token
string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Explicit name, nonempty audience and optional selected menu for first creation.

object
Title

Display title, trimmed and bounded to 128 characters.

string
nullable
RoleIds

Existing workspace roles in the audience.

Array<string>
nullable
UserIds

Existing workspace users in the audience.

Array<string>
nullable
RuntimeMenuId

Selected menu; null chooses or creates the preferred menu.

string
nullable
Examplegenerated
{
"Title": "example",
"RoleIds": [
"example"
],
"UserIds": [
"example"
],
"RuntimeMenuId": "example"
}

OK

Media typeapplication/json
object
Data

Durable target of first creation or a non-mutating repeat. Source grants remain separate.

object
DefinitionId

Bound Reporting identity.

string
nullable
Kind

The two independently generated, customer-editable Reporting definitions.

integer format: int32
Allowed values: 0 1
Created

Whether this request created and published the definition.

boolean
RuntimeMenuId

Menu changed by first creation; null on a non-mutating repeat.

string
nullable
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Data": {
"Kind": 0
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Bad Request

Media typeapplication/json
object
Data

Durable target of first creation or a non-mutating repeat. Source grants remain separate.

object
DefinitionId

Bound Reporting identity.

string
nullable
Kind

The two independently generated, customer-editable Reporting definitions.

integer format: int32
Allowed values: 0 1
Created

Whether this request created and published the definition.

boolean
RuntimeMenuId

Menu changed by first creation; null on a non-mutating repeat.

string
nullable
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Data": {
"Kind": 0
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Forbidden

Media typeapplication/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Conflict

Media typeapplication/json
object
Data

Durable target of first creation or a non-mutating repeat. Source grants remain separate.

object
DefinitionId

Bound Reporting identity.

string
nullable
Kind

The two independently generated, customer-editable Reporting definitions.

integer format: int32
Allowed values: 0 1
Created

Whether this request created and published the definition.

boolean
RuntimeMenuId

Menu changed by first creation; null on a non-mutating repeat.

string
nullable
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Data": {
"Kind": 0
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}