Base office

POSTCreate document

{doctype_webhook_url}

Bodyformdata

username

@tag

Creator

metatype

ann

ann (Announcement) || doc_received (Receiving document) || doc_sent (Outgoing document) || internal (Internal document)

name

Name

Document title (string)

content

Content

Document content (string)

collection_id

Selected collection (integer)

storage_id

Document storage (integer)

scode-prefix

string

example: scode-counter, scode-month

team_id

Send from (integer)

teams

@team

Recipients (split with comma) ex: teamname (@team1), teamname2 (@team2)

followers

@tag

Followers

Email notification: Yes (1), No (0)

notify

Notification : Yes (1), No (0)

status

Published (1) / Need review (0)

approvals

@tag

Reviewers

sender_name

string

Company/ Organization name (only valid for Receiving document)

sender_dept

string

Team/deparment name (only valid for Receiving document)

sender_email

string

Email address (only valid for Receiving document)

sender_phone

string

Phone number (only valid for Receiving document)

sender_address

string

Address (only valid for Receiving document)

sender_date

date

Date (only valid for Receiving document)

sender_note

string

More info (only valid for Receiving document)

ext_name_index

string

index (0 -> 9) (only valid for Outgoing document)

ext_dept_index

string

index (0 -> 9) (only valid for Outgoing document)

ext_email_index

string

index (0 -> 9) (only valid for Outgoing document)

ext_note_index

string

index (0 -> 9) (only valid for Outgoing document)

file-index

index (0 -> 9)

tags

string

released_date

string

Issued date EG: 12/12/2022

effective_date

string

Effective date EG: 12/12/2022

expired_date

string

Expired date EG: 12/12/2022

Example Request

curl

curl --location -g '{doctype_webhook_url}' \
--form 'username="@tag"' \
--form 'metatype="ann"' \
--form 'name="Name"' \
--form 'content="Content"' \
--form 'collection_id="id"' \
--form 'storage_id="id"' \
--form 'scode-prefix="string"' \
--form 'team_id="id"' \
--form 'teams="@team"' \
--form 'followers="@tag"' \
--form 'email="0"' \
--form 'notify="1"' \
--form 'status="1"' \
--form 'approvals="@tag"' \
--form 'sender_name="string"' \
--form 'sender_dept="string"' \
--form 'sender_email="string"' \
--form 'sender_phone="string"' \
--form 'sender_address="string"' \
--form 'sender_date="date"' \
--form 'sender_note="string"' \
--form 'ext_name_index="string"' \
--form 'ext_dept_index="string"' \
--form 'ext_email_index="string"' \
--form 'ext_note_index="string"' \
--form 'file-index=@"/path/to/file"' \
--form 'tags="string"' \
--form 'released_date="string"' \
--form 'effective_date="string"' \
--form 'expired_date="string"'

Example Response

No response body

This request doesn't return any response body

No response headers

This request doesn't return any response headers

GETGet documents

https://{BASE_OFFICE_DOMAIN}/extapi/v1/docs/get?access_token={access_token}&page={page}

PARAMS

access_token

{access_token}

page

{page}

Example Request

curl

curl --location -g 'https://{BASE_OFFICE_DOMAIN}/extapi/v1/docs/get?access_token={access_token}&page={page}'

Example Response

No response body

This request doesn't return any response body

No response headers

This request doesn't return any response headers