Skip to main content
Create Default Suggested Document Entity

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.

Response

OK

Carrier object for SuggestedDocumentEntity. Services for the SuggestedDocumentEntity Carrier is available from the Document Agent.

SuggestedDocumentId
integer<int32>

Primary key

Name
string

Item name, visible in Guide

Tooltip
string

Tooltip / description

Rank
integer<int32>

Rank, controls rank of non-instantiated items in Guide

DoctmplId
integer<int32>

Type of the suggested document

Header
string

Suggested 'header'

OurRef
string

Suggested 'our reference'

Deleted
boolean

0 -> record is active 1 -> record is 'deleted' and should not be shown in lists

DocTmpl
object

The template a document is based on is stored in the SO_arc\template folder on the server. This will return the name as displayed in the GUI, and not the physical document name, of the template the document object is based on. Carrier object for DocumentTemplate. Services for the DocumentTemplate Carrier is available from the List Agent.

Carrier object for ProjectTypeStatusLink.

Carrier object for SaleTypeStageLink.

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.