WSE · Schnittstellen

Reporting

Verbinden Sie WSE mit Ihren Anwendungen. Entdecken Sie Endpunkte, Datenmodelle und Schnittstellen – nach Funktionsbereichen und Add-ons geordnet.

OpenAPI herunterladen ↓
REST · JSONBearer-Authentifizierung
API docs by Redocly

Reporting

ERP API Dokumentation

Auswertungen & OData

Add-on erforderlich: Reporting. Die Nutzung setzt das freigeschaltete Add-on und passende Benutzerberechtigungen voraus.

Catalog

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/catalog' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "version": 1,
  • "datasets": [
    ],
  • "default_page_size": 500,
  • "max_page_size": 2000,
  • "max_filter_depth": 6,
  • "max_filter_conditions": 64,
  • "comparison_operators": [
    ],
  • "string_functions": [
    ],
  • "date_granularities": [
    ]
}

Query

Authorizations:
BearerAuth
Request Body schema: application/json
required
required
object (QueryDefinition-Input)
dataset
required
string (Dataset) ^[A-Za-z_][A-Za-z0-9_]{0,99}$
version
integer (Version)
Default: 1
Value: 1
Array of Select (strings) or Select (null) (Select)
Filter (any) or Filter (null) (Filter)
Array of objects (Group By) <= 10 items
Array of objects (Aggregates) <= 20 items
Array of objects (Order By) <= 10 items
page_size
integer (Page Size) [ 1 .. 2000 ]
Default: 500
Cursor (string) or Cursor (null) (Cursor)
Any of
<= 16384 characters
string (Cursor) <= 16384 characters
include_count
boolean (Include Count)
Default: false
Visualization (object) or null
Any of
type
string (Type)
Default: "table"
Enum: "table" "bar" "line" "pie"
Category (string) or Category (null) (Category)
measures
Array of strings (Measures) <= 20 items [ items^[A-Za-z_][A-Za-z0-9_]{0,99}$ ]
Series (string) or Series (null) (Series)
title
string (Title) <= 200 characters
Default: ""
category_label
string (Category Label) <= 200 characters
Default: ""
value_label
string (Value Label) <= 200 characters
Default: ""
orientation
string (Orientation)
Default: "vertical"
Enum: "vertical" "horizontal"
fill_missing
boolean (Fill Missing)
Default: false
Period Field (string) or Period Field (null) (Period Field)
Period Start (string) or Period Start (null) (Period Start)
Period End (string) or Period End (null) (Period End)
Relative Months (integer) or Relative Months (null) (Relative Months)

Responses

Request samples

Content type
application/json
{
  • "page_size": 500,
  • "cursor": "string",
  • "include_count": false,
  • "definition": {
    },
  • "visualization": {
    }
}

Response samples

Content type
application/json
{
  • "reference_date": "2019-08-24",
  • "query_revision": 0,
  • "period_start": "2019-08-24",
  • "period_end": "2019-08-24",
  • "columns": [
    ],
  • "rows": [
    ],
  • "next_cursor": "string",
  • "count": 0
}

List Queries

Authorizations:
BearerAuth
query Parameters
After (string) or After (null) (After)
limit
integer (Limit) [ 1 .. 200 ]
Default: 50

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/queries?after=497f6eca-6276-4993-bfeb-53cbbbba6f08&limit=50' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "next_cursor": "a7ec8888-a9c3-4732-a281-9a08510f220b"
}

Create Query

Authorizations:
BearerAuth
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 200 ] characters \S
required
object (QueryDefinition-Input)
dataset
required
string (Dataset) ^[A-Za-z_][A-Za-z0-9_]{0,99}$
version
integer (Version)
Default: 1
Value: 1
Array of Select (strings) or Select (null) (Select)
Filter (any) or Filter (null) (Filter)
Array of objects (Group By) <= 10 items
Array of objects (Aggregates) <= 20 items
Array of objects (Order By) <= 10 items
Description (string) or Description (null) (Description)
Any of
<= 2000 characters
string (Description) <= 2000 characters
visibility
string (Visibility)
Default: "private"
Enum: "private" "shared"
Visualization (object) or null
Any of
type
string (Type)
Default: "table"
Enum: "table" "bar" "line" "pie"
Category (string) or Category (null) (Category)
measures
Array of strings (Measures) <= 20 items [ items^[A-Za-z_][A-Za-z0-9_]{0,99}$ ]
Series (string) or Series (null) (Series)
title
string (Title) <= 200 characters
Default: ""
category_label
string (Category Label) <= 200 characters
Default: ""
value_label
string (Value Label) <= 200 characters
Default: ""
orientation
string (Orientation)
Default: "vertical"
Enum: "vertical" "horizontal"
fill_missing
boolean (Fill Missing)
Default: false
Period Field (string) or Period Field (null) (Period Field)
Period Start (string) or Period Start (null) (Period Start)
Period End (string) or Period End (null) (Period End)
Relative Months (integer) or Relative Months (null) (Relative Months)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "visibility": "private",
  • "definition": {
    },
  • "visualization": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "visibility": "private",
  • "definition": {
    },
  • "visualization": {
    },
  • "query_id": "6fa29c22-6bab-424a-859e-a13a5c607e72",
  • "owner_actor_id": "3bf288fc-ba48-4ae4-9802-b59cc9a4b067",
  • "revision": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get Query

Authorizations:
BearerAuth
path Parameters
query_id
required
string <uuid> (Query Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/queries/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "visibility": "private",
  • "definition": {
    },
  • "visualization": {
    },
  • "query_id": "6fa29c22-6bab-424a-859e-a13a5c607e72",
  • "owner_actor_id": "3bf288fc-ba48-4ae4-9802-b59cc9a4b067",
  • "revision": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update Query

Authorizations:
BearerAuth
path Parameters
query_id
required
string <uuid> (Query Id)
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 200 ] characters \S
required
object (QueryDefinition-Input)
dataset
required
string (Dataset) ^[A-Za-z_][A-Za-z0-9_]{0,99}$
version
integer (Version)
Default: 1
Value: 1
Array of Select (strings) or Select (null) (Select)
Filter (any) or Filter (null) (Filter)
Array of objects (Group By) <= 10 items
Array of objects (Aggregates) <= 20 items
Array of objects (Order By) <= 10 items
revision
required
integer (Revision) >= 1
Description (string) or Description (null) (Description)
Any of
<= 2000 characters
string (Description) <= 2000 characters
visibility
string (Visibility)
Default: "private"
Enum: "private" "shared"
Visualization (object) or null
Any of
type
string (Type)
Default: "table"
Enum: "table" "bar" "line" "pie"
Category (string) or Category (null) (Category)
measures
Array of strings (Measures) <= 20 items [ items^[A-Za-z_][A-Za-z0-9_]{0,99}$ ]
Series (string) or Series (null) (Series)
title
string (Title) <= 200 characters
Default: ""
category_label
string (Category Label) <= 200 characters
Default: ""
value_label
string (Value Label) <= 200 characters
Default: ""
orientation
string (Orientation)
Default: "vertical"
Enum: "vertical" "horizontal"
fill_missing
boolean (Fill Missing)
Default: false
Period Field (string) or Period Field (null) (Period Field)
Period Start (string) or Period Start (null) (Period Start)
Period End (string) or Period End (null) (Period End)
Relative Months (integer) or Relative Months (null) (Relative Months)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "visibility": "private",
  • "definition": {
    },
  • "visualization": {
    },
  • "revision": 1
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "visibility": "private",
  • "definition": {
    },
  • "visualization": {
    },
  • "query_id": "6fa29c22-6bab-424a-859e-a13a5c607e72",
  • "owner_actor_id": "3bf288fc-ba48-4ae4-9802-b59cc9a4b067",
  • "revision": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete Query

Authorizations:
BearerAuth
path Parameters
query_id
required
string <uuid> (Query Id)
query Parameters
revision
required
integer (Revision) >= 1

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request DELETE \
  --url 'https://your-instance.example.invalid/reporting/v1/queries/497f6eca-6276-4993-bfeb-53cbbbba6f08?revision=1' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Execute Saved Query

Authorizations:
BearerAuth
path Parameters
query_id
required
string <uuid> (Query Id)
Request Body schema: application/json
required
page_size
integer (Page Size) [ 1 .. 2000 ]
Default: 500
Cursor (string) or Cursor (null) (Cursor)
Any of
<= 16384 characters
string (Cursor) <= 16384 characters
include_count
boolean (Include Count)
Default: false
ReportPeriod (object) or null
Any of
Period Start (string) or Period Start (null) (Period Start)
Period End (string) or Period End (null) (Period End)
Relative Months (integer) or Relative Months (null) (Relative Months)
Period Field (string) or Period Field (null) (Period Field)
Any of
string (Period Field) ^[A-Za-z_][A-Za-z0-9_]{0,99}$
Reference Date (string) or Reference Date (null) (Reference Date)
Any of
string <date> (Reference Date)
Query Revision (integer) or Query Revision (null) (Query Revision)
Any of
>= 1
integer (Query Revision) >= 1

Responses

Request samples

Content type
application/json
{
  • "page_size": 500,
  • "cursor": "string",
  • "include_count": false,
  • "period": {
    },
  • "period_field": "string",
  • "reference_date": "2019-08-24",
  • "query_revision": 1
}

Response samples

Content type
application/json
{
  • "reference_date": "2019-08-24",
  • "query_revision": 0,
  • "period_start": "2019-08-24",
  • "period_end": "2019-08-24",
  • "columns": [
    ],
  • "rows": [
    ],
  • "next_cursor": "string",
  • "count": 0
}

Execution Context

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/execution-context' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "reference_date": "2019-08-24"
}

List Dashboards

Authorizations:
BearerAuth
query Parameters
After (string) or After (null) (After)
limit
integer (Limit) [ 1 .. 200 ]
Default: 50

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/dashboards?after=497f6eca-6276-4993-bfeb-53cbbbba6f08&limit=50' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "next_cursor": "a7ec8888-a9c3-4732-a281-9a08510f220b"
}

Create Dashboard

Authorizations:
BearerAuth
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 200 ] characters \S
required
object (DashboardConfiguration)
version
integer (Version)
Default: 1
Value: 1
ReportPeriod (object) or null
Array of objects (Widgets) <= 20 items
Description (string) or Description (null) (Description)
Any of
<= 2000 characters
string (Description) <= 2000 characters
visibility
string (Visibility)
Default: "private"
Enum: "private" "shared"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "visibility": "private",
  • "configuration": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "visibility": "private",
  • "configuration": {
    },
  • "revision": 1,
  • "dashboard_id": "6904cee6-5a01-4acf-92d9-7e185cd226de",
  • "owner_actor_id": "3bf288fc-ba48-4ae4-9802-b59cc9a4b067",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get Dashboard

Authorizations:
BearerAuth
path Parameters
dashboard_id
required
string <uuid> (Dashboard Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/dashboards/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "visibility": "private",
  • "configuration": {
    },
  • "revision": 1,
  • "dashboard_id": "6904cee6-5a01-4acf-92d9-7e185cd226de",
  • "owner_actor_id": "3bf288fc-ba48-4ae4-9802-b59cc9a4b067",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update Dashboard

Authorizations:
BearerAuth
path Parameters
dashboard_id
required
string <uuid> (Dashboard Id)
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 200 ] characters \S
required
object (DashboardConfiguration)
version
integer (Version)
Default: 1
Value: 1
ReportPeriod (object) or null
Array of objects (Widgets) <= 20 items
revision
required
integer (Revision) >= 1
Description (string) or Description (null) (Description)
Any of
<= 2000 characters
string (Description) <= 2000 characters
visibility
string (Visibility)
Default: "private"
Enum: "private" "shared"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "visibility": "private",
  • "configuration": {
    },
  • "revision": 1
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "visibility": "private",
  • "configuration": {
    },
  • "revision": 1,
  • "dashboard_id": "6904cee6-5a01-4acf-92d9-7e185cd226de",
  • "owner_actor_id": "3bf288fc-ba48-4ae4-9802-b59cc9a4b067",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete Dashboard

Authorizations:
BearerAuth
path Parameters
dashboard_id
required
string <uuid> (Dashboard Id)
query Parameters
revision
required
integer (Revision) >= 1

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request DELETE \
  --url 'https://your-instance.example.invalid/reporting/v1/dashboards/497f6eca-6276-4993-bfeb-53cbbbba6f08?revision=1' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Reporting Odata Service Document

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/odata/' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Metadata

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/odata/$metadata' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Reporting Odata Customers List

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/odata/Customers' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Reporting Odata Customers Count

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/odata/Customers/$count' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Reporting Odata Customers Get

Authorizations:
BearerAuth
path Parameters
key
required
string (Key)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/odata/Customers(string)' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Reporting Odata Products List

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/odata/Products' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Reporting Odata Products Count

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/odata/Products/$count' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Reporting Odata Products Get

Authorizations:
BearerAuth
path Parameters
key
required
string (Key)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/odata/Products(string)' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Reporting Odata Productgroups List

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/odata/ProductGroups' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Reporting Odata Productgroups Count

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/odata/ProductGroups/$count' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Reporting Odata Productgroups Get

Authorizations:
BearerAuth
path Parameters
key
required
string (Key)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/odata/ProductGroups(string)' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Reporting Odata Services List

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/odata/Services' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Reporting Odata Services Count

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/odata/Services/$count' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Reporting Odata Services Get

Authorizations:
BearerAuth
path Parameters
key
required
string (Key)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/odata/Services(string)' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Reporting Odata Servicelifecycle List

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/odata/ServiceLifecycle' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Reporting Odata Servicelifecycle Count

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/odata/ServiceLifecycle/$count' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Reporting Odata Servicelifecycle Get

Authorizations:
BearerAuth
path Parameters
key
required
string (Key)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/odata/ServiceLifecycle(string)' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Reporting Odata Serviceproducts List

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/odata/ServiceProducts' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Reporting Odata Serviceproducts Count

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/odata/ServiceProducts/$count' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Reporting Odata Serviceproducts Get

Authorizations:
BearerAuth
path Parameters
key
required
string (Key)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/odata/ServiceProducts(string)' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Reporting Odata Billingdocuments List

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/odata/BillingDocuments' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Reporting Odata Billingdocuments Count

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/odata/BillingDocuments/$count' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Reporting Odata Billingdocuments Get

Authorizations:
BearerAuth
path Parameters
key
required
string (Key)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/odata/BillingDocuments(string)' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Reporting Odata Billinglines List

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/odata/BillingLines' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Reporting Odata Billinglines Count

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/odata/BillingLines/$count' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Reporting Odata Billinglines Get

Authorizations:
BearerAuth
path Parameters
key
required
string (Key)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/odata/BillingLines(string)' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Reporting Odata Openitems List

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/odata/OpenItems' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Reporting Odata Openitems Count

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/odata/OpenItems/$count' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Reporting Odata Openitems Get

Authorizations:
BearerAuth
path Parameters
key
required
string (Key)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/odata/OpenItems(string)' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Reporting Odata Settlements List

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/odata/Settlements' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Reporting Odata Settlements Count

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/odata/Settlements/$count' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Reporting Odata Settlements Get

Authorizations:
BearerAuth
path Parameters
key
required
string (Key)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/odata/Settlements(string)' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Reporting Odata Settlementallocations List

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/odata/SettlementAllocations' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Reporting Odata Settlementallocations Count

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/odata/SettlementAllocations/$count' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Reporting Odata Settlementallocations Get

Authorizations:
BearerAuth
path Parameters
key
required
string (Key)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/odata/SettlementAllocations(string)' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Reporting Odata Cashbooks List

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/odata/Cashbooks' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Reporting Odata Cashbooks Count

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/odata/Cashbooks/$count' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Reporting Odata Cashbooks Get

Authorizations:
BearerAuth
path Parameters
key
required
string (Key)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/odata/Cashbooks(string)' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Reporting Odata Cashbookentries List

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/odata/CashbookEntries' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Reporting Odata Cashbookentries Count

Authorizations:
BearerAuth

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/odata/CashbookEntries/$count' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Reporting Odata Cashbookentries Get

Authorizations:
BearerAuth
path Parameters
key
required
string (Key)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/reporting/v1/odata/CashbookEntries(string)' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}