Skip to main content
Save Project Entity Copy

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.

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

$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.

Body

ProjectEntity, SourceProjectId, Options

SaveProjectEntityCopy: Save a project copy prepared by CreateProjectEntityFromExisting, optionally copying members, note, links and image of the source project along with it. The server rebuilds the copy from the source project and takes only Name and Associate (the project owner) from the passed entity; every other value on it is ignored. Members, note, links and image are read from the source project, not from the passed entity. Pass null options, or options with nothing set, to copy the project alone.

ProjectEntity
object

The Project Service. The service implements all services working with the Project object Carrier object for ProjectEntity. Services for the ProjectEntity Carrier is available from the Project Agent.

SourceProjectId
integer<int32>
Options
object

Which optional parts to copy alongside a project, for ProjectAgent.SaveProjectEntityCopy. Options live here rather than as parameters on the operation, so a new one can be added without changing the signature. Nothing set copies the project alone. Carrier object for ProjectCopyOptions. Services for the ProjectCopyOptions Carrier is available from the Project Agent.

Response

OK

Result of saving a copied project: the project that was created, and what became of each optional part. Carrier object for ProjectCopyResult. Services for the ProjectCopyResult Carrier is available from the Project Agent.

ProjectId
integer<int32>

Id of the project that was created.

MembersResult
enum<string>

What became of the members: not requested, copied, nothing on the source to copy, or attempted and failed.

Available options:
NotRequested,
Success,
Failure,
NothingToCopy
NoteResult
enum<string>

What became of the note: not requested, copied, nothing on the source to copy, or attempted and failed.

Available options:
NotRequested,
Success,
Failure,
NothingToCopy

What became of the links: not requested, copied, nothing on the source to copy, or attempted and failed.

Available options:
NotRequested,
Success,
Failure,
NothingToCopy
ImageResult
enum<string>

What became of the image: not requested, copied, nothing on the source to copy, or attempted and failed.

Available options:
NotRequested,
Success,
Failure,
NothingToCopy
Warnings
string[]

One localized explanation per optional part that was requested but could not be copied, so a caller can present them separately rather than unpicking one joined string. Empty when everything requested succeeded. The project itself is always created - a failure here never means the project is missing.