Post documenttypev1libraries documenttypes ossfield

cURL

curl --request POST \
  --url https://aodocs.altirnao.com/api/documentType/v1/libraries/{libraryId}/documentTypes/{classId}/ossField \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://aodocs.altirnao.com/api/documentType/v1/libraries/{libraryId}/documentTypes/{classId}/ossField"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://aodocs.altirnao.com/api/documentType/v1/libraries/{libraryId}/documentTypes/{classId}/ossField', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://aodocs.altirnao.com/api/documentType/v1/libraries/{libraryId}/documentTypes/{classId}/ossField",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://aodocs.altirnao.com/api/documentType/v1/libraries/{libraryId}/documentTypes/{classId}/ossField"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://aodocs.altirnao.com/api/documentType/v1/libraries/{libraryId}/documentTypes/{classId}/ossField")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://aodocs.altirnao.com/api/documentType/v1/libraries/{libraryId}/documentTypes/{classId}/ossField")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "appMetadata": {},
  "calculatedSettings": {},
  "calculatedValue": {
    "code": "<string>"
  },
  "categoryDefinition": {
    "description": "<string>",
    "dynamicValues": true,
    "folder": true,
    "id": "<string>",
    "kind": "<string>",
    "levelNames": [
      "<string>"
    ],
    "levelNames_i18n": [
      "<string>"
    ],
    "libraryId": "<string>",
    "name": "<string>",
    "tags": true,
    "value": "<string>"
  },
  "categoryId": "<string>",
  "categoryValueMapping": {
    "displayName": "<string>",
    "id": "<string>"
  },
  "columns": [
    {
      "appMetadata": {},
      "calculatedSettings": {},
      "calculatedValue": {
        "code": "<string>"
      },
      "categoryDefinition": {
        "description": "<string>",
        "dynamicValues": true,
        "folder": true,
        "id": "<string>",
        "kind": "<string>",
        "levelNames": [
          "<string>"
        ],
        "levelNames_i18n": [
          "<string>"
        ],
        "libraryId": "<string>",
        "name": "<string>",
        "tags": true,
        "value": "<string>"
      },
      "categoryId": "<string>",
      "categoryValueMapping": {
        "displayName": "<string>",
        "id": "<string>"
      },
      "columns": "<unknown>",
      "creationSettings": {
        "hidden": true,
        "mandatory": true,
        "readOnly": true
      },
      "customPlaceholder": true,
      "description": "<string>",
      "displayInPreview": {},
      "displayName": "<string>",
      "dynamicValues": true,
      "folder": true,
      "hidden": true,
      "id": "<string>",
      "kind": "<string>",
      "levelNames": [
        "<string>"
      ],
      "lookupConfiguration": {
        "sourceConfiguration": {
          "displaySearchProperties": [
            "<string>"
          ],
          "freezeStates": [
            "<string>"
          ],
          "scope": {
            "id": "<string>",
            "type": "CLASS"
          },
          "synchronizationRule": "NEVER",
          "type": "DOCUMENT"
        },
        "targetConfiguration": {
          "lookupKey": "<string>",
          "sourceFieldId": "<string>",
          "sourceFieldName": "<string>"
        }
      },
      "mandatory": true,
      "mappingSourceField": {
        "displayName": "<string>",
        "id": "<string>"
      },
      "multiple": true,
      "placeholderText": "<string>",
      "rank": 123,
      "readOnly": true,
      "referenceCatalog": {
        "createdAt": 123,
        "id": "<string>",
        "kind": "<string>",
        "levelNames": [
          "<string>"
        ],
        "modifiedAt": 123,
        "name": "<string>",
        "numberOfValues": 123
      },
      "referenceCatalogId": "<string>",
      "type": "STRING",
      "validation": {
        "audience": {
          "classId": "<string>",
          "className": "<string>",
          "description": "<string>",
          "displayName": "<string>",
          "displayName_i18n": "<string>",
          "thumbnailPictureUrl": "<string>",
          "type": "USER",
          "value": "<string>"
        },
        "errorMessage": "<string>",
        "kind": "<string>",
        "lowerLimit": 123,
        "lowerLimitInclusive": true,
        "mandatoryLeaf": true,
        "regex": "<string>",
        "upperLimit": 123,
        "upperLimitInclusive": true
      }
    }
  ],
  "creationSettings": {
    "hidden": true,
    "mandatory": true,
    "readOnly": true
  },
  "customPlaceholder": true,
  "description": "<string>",
  "displayInPreview": {},
  "displayName": "<string>",
  "dynamicValues": true,
  "folder": true,
  "hidden": true,
  "id": "<string>",
  "kind": "<string>",
  "levelNames": [
    "<string>"
  ],
  "lookupConfiguration": {
    "sourceConfiguration": {
      "displaySearchProperties": [
        "<string>"
      ],
      "freezeStates": [
        "<string>"
      ],
      "scope": {
        "id": "<string>",
        "type": "CLASS"
      },
      "synchronizationRule": "NEVER",
      "type": "DOCUMENT"
    },
    "targetConfiguration": {
      "lookupKey": "<string>",
      "sourceFieldId": "<string>",
      "sourceFieldName": "<string>"
    }
  },
  "mandatory": true,
  "mappingSourceField": {
    "displayName": "<string>",
    "id": "<string>"
  },
  "multiple": true,
  "placeholderText": "<string>",
  "rank": 123,
  "readOnly": true,
  "referenceCatalog": {
    "createdAt": 123,
    "id": "<string>",
    "kind": "<string>",
    "levelNames": [
      "<string>"
    ],
    "modifiedAt": 123,
    "name": "<string>",
    "numberOfValues": 123
  },
  "referenceCatalogId": "<string>",
  "type": "STRING",
  "validation": {
    "audience": {
      "classId": "<string>",
      "className": "<string>",
      "description": "<string>",
      "displayName": "<string>",
      "displayName_i18n": "<string>",
      "thumbnailPictureUrl": "<string>",
      "type": "USER",
      "value": "<string>"
    },
    "errorMessage": "<string>",
    "kind": "<string>",
    "lowerLimit": 123,
    "lowerLimitInclusive": true,
    "mandatoryLeaf": true,
    "regex": "<string>",
    "upperLimit": 123,
    "upperLimitInclusive": true
  }
}

POST

documentType

libraries

{libraryId}

documentTypes

{classId}

ossField

cURL

curl --request POST \
  --url https://aodocs.altirnao.com/api/documentType/v1/libraries/{libraryId}/documentTypes/{classId}/ossField \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://aodocs.altirnao.com/api/documentType/v1/libraries/{libraryId}/documentTypes/{classId}/ossField"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://aodocs.altirnao.com/api/documentType/v1/libraries/{libraryId}/documentTypes/{classId}/ossField', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://aodocs.altirnao.com/api/documentType/v1/libraries/{libraryId}/documentTypes/{classId}/ossField",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://aodocs.altirnao.com/api/documentType/v1/libraries/{libraryId}/documentTypes/{classId}/ossField"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://aodocs.altirnao.com/api/documentType/v1/libraries/{libraryId}/documentTypes/{classId}/ossField")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://aodocs.altirnao.com/api/documentType/v1/libraries/{libraryId}/documentTypes/{classId}/ossField")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "appMetadata": {},
  "calculatedSettings": {},
  "calculatedValue": {
    "code": "<string>"
  },
  "categoryDefinition": {
    "description": "<string>",
    "dynamicValues": true,
    "folder": true,
    "id": "<string>",
    "kind": "<string>",
    "levelNames": [
      "<string>"
    ],
    "levelNames_i18n": [
      "<string>"
    ],
    "libraryId": "<string>",
    "name": "<string>",
    "tags": true,
    "value": "<string>"
  },
  "categoryId": "<string>",
  "categoryValueMapping": {
    "displayName": "<string>",
    "id": "<string>"
  },
  "columns": [
    {
      "appMetadata": {},
      "calculatedSettings": {},
      "calculatedValue": {
        "code": "<string>"
      },
      "categoryDefinition": {
        "description": "<string>",
        "dynamicValues": true,
        "folder": true,
        "id": "<string>",
        "kind": "<string>",
        "levelNames": [
          "<string>"
        ],
        "levelNames_i18n": [
          "<string>"
        ],
        "libraryId": "<string>",
        "name": "<string>",
        "tags": true,
        "value": "<string>"
      },
      "categoryId": "<string>",
      "categoryValueMapping": {
        "displayName": "<string>",
        "id": "<string>"
      },
      "columns": "<unknown>",
      "creationSettings": {
        "hidden": true,
        "mandatory": true,
        "readOnly": true
      },
      "customPlaceholder": true,
      "description": "<string>",
      "displayInPreview": {},
      "displayName": "<string>",
      "dynamicValues": true,
      "folder": true,
      "hidden": true,
      "id": "<string>",
      "kind": "<string>",
      "levelNames": [
        "<string>"
      ],
      "lookupConfiguration": {
        "sourceConfiguration": {
          "displaySearchProperties": [
            "<string>"
          ],
          "freezeStates": [
            "<string>"
          ],
          "scope": {
            "id": "<string>",
            "type": "CLASS"
          },
          "synchronizationRule": "NEVER",
          "type": "DOCUMENT"
        },
        "targetConfiguration": {
          "lookupKey": "<string>",
          "sourceFieldId": "<string>",
          "sourceFieldName": "<string>"
        }
      },
      "mandatory": true,
      "mappingSourceField": {
        "displayName": "<string>",
        "id": "<string>"
      },
      "multiple": true,
      "placeholderText": "<string>",
      "rank": 123,
      "readOnly": true,
      "referenceCatalog": {
        "createdAt": 123,
        "id": "<string>",
        "kind": "<string>",
        "levelNames": [
          "<string>"
        ],
        "modifiedAt": 123,
        "name": "<string>",
        "numberOfValues": 123
      },
      "referenceCatalogId": "<string>",
      "type": "STRING",
      "validation": {
        "audience": {
          "classId": "<string>",
          "className": "<string>",
          "description": "<string>",
          "displayName": "<string>",
          "displayName_i18n": "<string>",
          "thumbnailPictureUrl": "<string>",
          "type": "USER",
          "value": "<string>"
        },
        "errorMessage": "<string>",
        "kind": "<string>",
        "lowerLimit": 123,
        "lowerLimitInclusive": true,
        "mandatoryLeaf": true,
        "regex": "<string>",
        "upperLimit": 123,
        "upperLimitInclusive": true
      }
    }
  ],
  "creationSettings": {
    "hidden": true,
    "mandatory": true,
    "readOnly": true
  },
  "customPlaceholder": true,
  "description": "<string>",
  "displayInPreview": {},
  "displayName": "<string>",
  "dynamicValues": true,
  "folder": true,
  "hidden": true,
  "id": "<string>",
  "kind": "<string>",
  "levelNames": [
    "<string>"
  ],
  "lookupConfiguration": {
    "sourceConfiguration": {
      "displaySearchProperties": [
        "<string>"
      ],
      "freezeStates": [
        "<string>"
      ],
      "scope": {
        "id": "<string>",
        "type": "CLASS"
      },
      "synchronizationRule": "NEVER",
      "type": "DOCUMENT"
    },
    "targetConfiguration": {
      "lookupKey": "<string>",
      "sourceFieldId": "<string>",
      "sourceFieldName": "<string>"
    }
  },
  "mandatory": true,
  "mappingSourceField": {
    "displayName": "<string>",
    "id": "<string>"
  },
  "multiple": true,
  "placeholderText": "<string>",
  "rank": 123,
  "readOnly": true,
  "referenceCatalog": {
    "createdAt": 123,
    "id": "<string>",
    "kind": "<string>",
    "levelNames": [
      "<string>"
    ],
    "modifiedAt": 123,
    "name": "<string>",
    "numberOfValues": 123
  },
  "referenceCatalogId": "<string>",
  "type": "STRING",
  "validation": {
    "audience": {
      "classId": "<string>",
      "className": "<string>",
      "description": "<string>",
      "displayName": "<string>",
      "displayName_i18n": "<string>",
      "thumbnailPictureUrl": "<string>",
      "type": "USER",
      "value": "<string>"
    },
    "errorMessage": "<string>",
    "kind": "<string>",
    "lowerLimit": 123,
    "lowerLimitInclusive": true,
    "mandatoryLeaf": true,
    "regex": "<string>",
    "upperLimit": 123,
    "upperLimitInclusive": true
  }
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Scopes

https://www.googleapis.com/auth/userinfo.email

google_id_token-a99f12e0

View your email address

https://www.googleapis.com/auth/userinfo.email

google_id_token_legacy-a99f12e0

View your email address

Path Parameters

libraryId

string

required

The ID of the library

classId

string

required

The ID of the document class

Query Parameters

remove

boolean

default:false

domain

string

The G Suite domain

Response

200 - application/json

A ApiClassField response

appMetadata

object

App Metadata let developers associate metadata with various configuration entities. The metadata is isolated within app namespaces in order to prevent one application from interfering with another's metadata.

Show child attributes

calculatedSettings

object

The configuration of calculated settings (mandatory/hidden)

Show child attributes

calculatedValue

object

Show child attributes

categoryDefinition

object

Show child attributes

categoryId

string

The ID of the category (if type = CATEGORY) - (deprecated, read-only)

categoryValueMapping

object

Show child attributes

columns

object[]

The column properties of the field (only if this field is a table type field)

Show child attributes

creationSettings

object

Show child attributes

customPlaceholder

boolean

Whether to use a custom placeholder when displaying the field in the UI

description

string

The description of the field

displayInPreview

object

The display in preview configuration of the field

Show child attributes

displayName

string

The name of the field

dynamicValues

boolean

folder

boolean

hidden

boolean

Whether the field should be hidden for the whole life-cycle of documents of the class

string

The ID of the field (read-only field)

kind

string

levelNames

string[]

lookupConfiguration

object

Show child attributes

mandatory

boolean

Whether the field should be mandatory for the whole life-cycle of documents of the class (not compatible for all field types)

mappingSourceField

object

Show child attributes

multiple

boolean

Whether the field should be multi-valued (not compatible for all field types)

placeholderText

string

The placeholder text if customPlaceholder = true

rank

integer<int32>

The rank of the field in the list (deprecated)

readOnly

boolean

Whether the field should be read-only for the whole life-cycle of documents of the class (not compatible for all field types)

referenceCatalog

object

Show child attributes

referenceCatalogId

string

The ID of the reference catalog (if type = REFERENCE_CATALOG)

type

enum<string>

The type of field (STRING, TEXT, DATE, TIME, DATETIME, INTEGER, DECIMAL, BOOLEAN, PERSON, GEOPOINT, URL, CATEGORY, REFERENCE_CATALOG, TABLE)

Available options:

STRING,

TEXT,

DATE,

TIME,

DATETIME,

INTEGER,

FILESIZE,

DECIMAL,

BOOLEAN,

PERSON,

CATEGORY,

GEOPOINT,

URL,

REFERENCE_CATALOG,

MIMETYPEGROUP,

CLASS,

FOLDER,

STATE,

OSS_ATTACHMENT,

DRIVE_ATTACHMENT,

TABLE

validation

object

Show child attributes

Attachment

Category

Document ID

Document

Document Type

Document View Config

Domain

Drive ID

Drive Import

Folder

Job

Library

Reference Catalog

Relation

Search

Templating

User

View

Workflow

Post documenttypev1libraries documenttypes ossfield

Authorizations

Scopes

Path Parameters

Query Parameters

Response