logo
Documentation Powered by Redocly

Octaved Flow (v1)

Download OpenAPI specification:Download

Documentation for the Octaved Flow API

Authentication

oauth

OAuth2 scheme

Security Scheme Type OAuth2
authorizationCode OAuth Flow
Authorization URL: /_oauth/v2/auth
Token URL: /_oauth/v2/token
Scopes:
  • flow:readBillings -

    Read billings

  • flow:readCustomers -

    Read customers

  • flow:readNodes -

    Read nodes of any type

  • flow:readPids -

    Read projects, groups and work packages

  • flow:readProjectFolders -

    Read project folders

  • flow:readTasks -

    Read tasks

  • flow:readTimeTrackingRecords -

    Read individual time tracking records

  • flow:readTimeTrackingReports -

    Read time tracking reports and evaluations

  • flow:readWorkflows -

    Read workflows

  • flow:triggerWebhooks -

    Trigger any webhook

  • flow:writeBillings -

    Write billings

  • flow:writeCustomers -

    Write customers

  • flow:writePids -

    Write projects, groups and work packages

  • flow:writeProjectFolders -

    Write project folders

  • flow:writeTasks -

    Write tasks

  • flow:writeTimeTrackingRecords -

    Write time tracking records

  • flow:writeWorkflows -

    Write workflows

Customers

Routes for customers

Gets customers

Gets all customers if no ids are provided in the query

Authorizations:
oauth (
  • flow:readCustomers
)
query Parameters
ids
Array of strings
Example: ids=E9996334F8134DBCBE18948284698BB2

UUIDs of the customers

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a customer

Authorizations:
oauth (
  • flow:writeCustomers
)
Request Body schema: application/json
customerNumber
string <= 191 characters

The customer number.

null or EnumFlowPidBillingType (string)
Default: null

The preselected billing type for new work packages in the GUI if this customer is not internal or requires charge.

fileExportLanguage
integer

Id of the language used in file exports such as time sheets.

isLocked
boolean
Default: false

Locked customers cannot be selected for new projects anymore.

isInternal
boolean
Default: false

Whether or not this is an internal customer.

name
required
string <= 191 characters

The name of the customer.

requiresInternalCharge
boolean
Default: false

If 'isInternal' is true, this flag controls whether or not the customer is charged.

object

Customer specific overrides to the price category settings.

object

Customer specific overrides to the price surcharge settings.

showSignatureFieldInPdfTimeSheets
boolean

Defaults to the system setting fileExports.timeSheets.showSignatureField.

null or UploadedFileIdentSchema (string)

Responses

Request samples

Content type
application/json
{
  • "customerNumber": "string",
  • "defaultBillingType": null,
  • "fileExportLanguage": 0,
  • "isLocked": false,
  • "isInternal": false,
  • "name": "string",
  • "requiresInternalCharge": false,
  • "priceCategoryOverrides": { },
  • "priceSurchargeOverrides": { },
  • "showSignatureFieldInPdfTimeSheets": true,
  • "logoFile": { }
}

Response samples

Content type
application/json
{
  • "id": "E9996334F8134DBCBE18948284698BB2"
}

Gets one customer

Authorizations:
oauth (
  • flow:readCustomers
)
path Parameters
customerId
required
string^[0-9A-F]{32}$
Example: E9996334F8134DBCBE18948284698BB2

UUID of the customer

Responses

Response samples

Content type
application/json
{
  • "id": "E9996334F8134DBCBE18948284698BB2",
  • "logoUrl": { },
  • "customerNumber": "string",
  • "defaultBillingType": null,
  • "fileExportLanguage": 0,
  • "isLocked": false,
  • "isInternal": false,
  • "name": "string",
  • "requiresInternalCharge": false,
  • "priceCategoryOverrides": { },
  • "priceSurchargeOverrides": { },
  • "showSignatureFieldInPdfTimeSheets": true
}

Creates a customer

Authorizations:
oauth (
  • flow:writeCustomers
)
path Parameters
customerId
required
string^[0-9A-F]{32}$
Example: E9996334F8134DBCBE18948284698BB2

UUID of the customer

Request Body schema: application/json
customerNumber
string <= 191 characters

The customer number.

null or EnumFlowPidBillingType (string)
Default: null

The preselected billing type for new work packages in the GUI if this customer is not internal or requires charge.

fileExportLanguage
integer

Id of the language used in file exports such as time sheets.

isLocked
boolean
Default: false

Locked customers cannot be selected for new projects anymore.

isInternal
boolean
Default: false

Whether or not this is an internal customer.

name
required
string <= 191 characters

The name of the customer.

requiresInternalCharge
boolean
Default: false

If 'isInternal' is true, this flag controls whether or not the customer is charged.

object

Customer specific overrides to the price category settings.

object

Customer specific overrides to the price surcharge settings.

showSignatureFieldInPdfTimeSheets
boolean

Defaults to the system setting fileExports.timeSheets.showSignatureField.

null or UploadedFileIdentSchema (string)

Responses

Request samples

Content type
application/json
{
  • "customerNumber": "string",
  • "defaultBillingType": null,
  • "fileExportLanguage": 0,
  • "isLocked": false,
  • "isInternal": false,
  • "name": "string",
  • "requiresInternalCharge": false,
  • "priceCategoryOverrides": { },
  • "priceSurchargeOverrides": { },
  • "showSignatureFieldInPdfTimeSheets": true,
  • "logoFile": { }
}

Patches a customer

Authorizations:
oauth (
  • flow:writeCustomers
)
path Parameters
customerId
required
string^[0-9A-F]{32}$
Example: E9996334F8134DBCBE18948284698BB2

UUID of the customer

Request Body schema: application/json
customerNumber
string <= 191 characters

The customer number.

null or EnumFlowPidBillingType (string)
Default: null

The preselected billing type for new work packages in the GUI if this customer is not internal or requires charge.

fileExportLanguage
integer

Id of the language used in file exports such as time sheets.

isLocked
boolean
Default: false

Locked customers cannot be selected for new projects anymore.

isInternal
boolean
Default: false

Whether or not this is an internal customer.

name
string <= 191 characters

The name of the customer.

requiresInternalCharge
boolean
Default: false

If 'isInternal' is true, this flag controls whether or not the customer is charged.

object

Customer specific overrides to the price category settings.

object

Customer specific overrides to the price surcharge settings.

showSignatureFieldInPdfTimeSheets
boolean

Defaults to the system setting fileExports.timeSheets.showSignatureField.

null or UploadedFileIdentSchema (string)

Responses

Request samples

Content type
application/json
{
  • "customerNumber": "string",
  • "defaultBillingType": null,
  • "fileExportLanguage": 0,
  • "isLocked": false,
  • "isInternal": false,
  • "name": "string",
  • "requiresInternalCharge": false,
  • "priceCategoryOverrides": { },
  • "priceSurchargeOverrides": { },
  • "showSignatureFieldInPdfTimeSheets": true,
  • "logoFile": { }
}

Deletes a customer

Authorizations:
oauth (
  • flow:writeCustomers
)
path Parameters
customerId
required
string^[0-9A-F]{32}$
Example: E9996334F8134DBCBE18948284698BB2

UUID of the customer

Responses

Simple search

Use one ident/value pair to search for a list of customer ids.
See the request body section for a list of supported search idents.

Authorizations:
oauth (
  • flow:readCustomers
)
path Parameters
ident
required
string
value
string

The content/format depends on the search ident.

Request Body schema: Supported search idents and their values
customerNumber
string non-empty
isInternal
string
Enum: "0" "1"
isLocked
string
Enum: "0" "1"
name
string non-empty
requiresInternalCharge
string
Enum: "0" "1"

Only finds internal customers

Responses

Response samples

Content type
application/json
[
  • "E9996334F8134DBCBE18948284698BB2"
]

Complex search

Use "and"-, "or"- or "not"-objects to assemble the desired search query. E.g.:

{"and":[{"ident":"propertyA","value":"foo"},{"or":[{"ident":"isOfSomeKindX"},{"ident":"propertyB","value":"bar"}]},{"not":{"ident":"isOfSomeKindY"}}]}

See the simple search request for the supported search idents.

Authorizations:
oauth (
  • flow:readCustomers
)
Request Body schema: application/json
One of
ident
required
string non-empty
value
string

Responses

Request samples

Content type
application/json
Example
condition
condition
and
or
{
  • "ident": "string",
  • "value": "string"
}

Response samples

Content type
application/json
[
  • "E9996334F8134DBCBE18948284698BB2"
]

Project Folders

Route