Skip to main content
Get Project

Authorizations

Authorization
string
header
required

SuperOffice username:password are passed in Base64-encoded.

You can also pass inn an unencoded ticket 7T:abc== with the HTTP Authenticate header.

Authorization
string
header
required

SuperOffice SuperId OAuth implicit flow. You need to issue a request to the SuperId authorization URL https://online.superoffice.com/login/common/oauth/authorize?response_type=token &client_id=670734e0-4c5a-11e3-be9e-a171392e81db &redirect_uri=https://example.com/spa/

passing in the application id and redirect URL.

SuperId will log the user in, and redirect to the requested redirect URL with a #payload containing the access token and claims. (The redirect URL must be registered with SuperId in advance)

https://example.com/spa#access_token=8A%3aCust12227.AXRrCITpPBvQX3UbIohb &token_type=bearer &state= &expires_in=3600 &ctx=Cust12227 &netserver_url=https%3a%2f%2fsod.superoffice.com%2fCust12227%2fRemote%2fServices82%2f

You can take the #access_token value and pass it as the Authenticate HTTP header as a BEARER token.

FlowImplicit
Authorization URL
https://online.superoffice.com/login/common/oauth/authorize

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

projectId
integer<int32>
required

The identifier of the Project object

$select
string

Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.

Response

OK

Carrier object for Project. Services for the Project Carrier is available from the Project Agent.

ProjectId
integer<int32>

Primary key

Name
string

Project name

Description
string

The projects description

URL
string

URL address

Type
string

The project type.

AssociateId
integer<int32>

The project owner id (associate id)

AssociateFullName
string

The project owner

TypeId
integer<int32>
Updated
string<date-time>

Last updated date in UTC.

StatusId
integer<int32>

The projects status id

Status
string

The projects status

TextId
integer<int32>

The id of the description

PublishTo
string<date-time>

Publication valid to (inclusive)

PublishFrom
string<date-time>

Publication valid from (inclusive)

IsPublished
boolean
URLName
string

Visible field

ProjectNumber
string

Automatically generated number

The number of active erp links

EventId
integer<int32>

Reserved field for Lyyti event when project is linked to an event.

StartDate
string<date-time>

Reserved field for Lyyti event when project is linked to an event, is the event start date.

TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.