Projects

Go to specific workflow step

post/api/Projects/GoToWorkflowStep

Request

  • Base URL: https://api.omnium.no (the document declares no server; this is the origin it was published from)
  • URL: https://api.omnium.no/api/Projects/GoToWorkflowStep
  • Auth: API key in header Authorization

Query parameters

runWorkflowboolean

Default true: the project type's workflow is processed for the step being moved to, which may notify the customer by email/SMS. Set to false to move the step silently - the step change, project log entry, deadline and any status transition are still saved, only the workflow actions are skipped

Request body

projectIdstring nullable

Project ID

datestring date-time nullable

Date

updateTypestring nullable

Next or previous or specific step

workflowStepIdstring nullable

Specific step

commentstring nullable

Workflow step comment

partnerIdstring nullable

Partner ID sending request

partnerNamestring nullable

Partner name sending the request

userIdstring nullable

User id sending the request

userNamestring nullable

User name sending the request

datastring nullable

Response

Success

idstring nullable

Unique Project ID. Is set by Omnium.

projectNumberstring nullable

Project number

versionIdstring nullable

Project version

externalReferencestring nullable

An external reference to project (optional)

namestring nullable

Project name

publicUrlstring nullable

URL to public project website

storeIdstring nullable

Store handling the project

typestring nullable

Project type ID

subTypestring nullable

Project subtype

statusstring nullable

Project status (Active / Completed / New etc). Populate from constant class OmniumProjectStatus.

projectTypeNamestring nullable

Name of project's project type.

hasMultiplePartnersboolean

True if project has more than one partner

createdstring date-time

Date project is created (UTC)

modifiedstring date-time

Date project is modified (UTC)

deadlinestring date-time nullable

Deadline based on current workflow step (UTC)

projectDatestring date-time nullable

Describing the date when the main activity of the project is performed.

rentalFromstring date-time nullable

Rental period start date (UTC). Only set for rental projects.

rentalTostring date-time nullable

Rental return date (UTC). The return day is not counted as a rental day. Only set for rental projects.

isRentalProjectboolean

True if this project tracks a rental lifecycle

canceledstring date-time nullable

Cancellation date of the project.

attachmentsRootDirectorystring nullable

Blob storage root directory for attachments on this project

projectCategorystring nullable

Project category (e.g. Claim, Service)

rejectedByPartnersstring[] nullable

List of partnerIds for partners who have rejected a project

cancellationCodestring nullable

Cancellation code - reason for cancelling project

cancellationReasonstring nullable

Reason for cancelling project - free text

projectValuenumber

Project value (Calculated if project has transactions)

projectAdditionalValuenumber

Additional project value. To manually adjust project value. Will be added to project value together with the transaction values.

projectBudgetValuenumber

Project budget value (Calculated if project has transactions)

tagsstring[] nullable

Project tags

rmaNumbersstring[] nullable

RMA numbers associated with the project. Set by Omnium when a claim is created from a return.

Changes

No recorded changes to this operation across all 1 revision of this API.