Please enable JavaScript to view this site.

Error itgendoc001X

xMsg javascript has not been loaded.

Simplicate API Data Model

Navigation: Schema: Projects > Tables

ProjectDocumentTypeById

Contents Previous Home Next More

Fetches a single document type for Projects by its id

Catalog: Simplicate

Schema: Projects

This is a read-only table function. The Simplicate API may not support changing the data or the Invantive SQL driver for Simplicate does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Simplicate API.

Select Simplicate API URL: /projects/documenttype/{id}

Insert Simplicate API URL: /projects/documenttype/{id}

Update Simplicate API URL: /projects/documenttype/{id}

Delete Simplicate API URL: /projects/documenttype/{id}

Field Selection Method: NotRequired

Base Path: data

Select Simplicate API Operation: get /projects/documenttype/{id}

Table Function Parameters

The following parameters can be used to control the behaviour of the table function ProjectDocumentTypeById. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be treated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example with `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.

Name

Data Type

Required

Default Value

Documentation

id

string

 

The template's id

 

Table Function Columns

The columns of the table function ProjectDocumentTypeById are shown below. Each column has an SQL data type.

Name

Data Type

Label

Required

Documentation

can_have_attachment

boolean

 

 

description

string

Description

 

id

string

ID

 

is_blocked

boolean

 

 

is_for_contact

boolean

 

 

is_for_crm

boolean

 

 

is_for_debtor

boolean

 

 

is_for_employee

boolean

 

 

is_for_invoice

boolean

 

 

is_for_myorganizationprofile

boolean

 

 

is_for_project

boolean

 

 

is_for_sale

boolean

 

 

is_for_subscription

boolean

 

 

is_visible_on_all

boolean

 

 

label

string

Label

 

 

06-04-2021 14:59 Version 20.1.393-BETA+3152