Create business workspace
POST {{baseUrl}}/v2/businessworkspaces/
Creates a business workspace or a business template.
NOTE: This can only be done passing the information as body
using JSON format.
The supported name/value pairs are:
parent_id
: <integer> - the parent ID.template_id
: <integer> - the workspace template ID.name
:<string>
- the name.name_multilingual
:<name/value pairs>
- the multilingual name. Example:name_multilingual
: {en
:Name_en
,de
:Name_de
description
:<string>
- the description.description_multilingual
:<name/value pairs>
- the multilingual description. Example:description_multilingual
: {en
:Description_en
,de
:Description_de
class_id
: <integer> - the classification ID.bo_id
:<string>
- the business object ID.bo_type_id
: <integer> - the business object type ID.bo_type
:<string>
- the business object type.ext_system_id
:<string>
- the external system ID.roles
: <name/value pairs> - the supported roles are:categories
,rmclassifications
andsecurityclearances
.ibo_workspace_id
: <integer> - the identical business workspace ID.wksp_type_id
: <integer> - the business workspace type ID.
The supported name/value pairs are optional.
If the
bo_type_idis not provided, then the business object type ID is determined from the values of
bo_typeand
ext_system_id.
If the
template_idis not provided, then the workspace template ID is determined from the values of
bo_type_idand
bo_id.
If the
template_idis provided, then the workspace type ID is determined from the value of
template_id, otherwise from
wksp_type_id.
Example to create an early business workspace:
body={
parent_id:14180,
template_id:14183,
name:
John Doe,
description:
Business Workspace of John Doe}
Example to create a late business workspace:
body={
bo_id:
171971,
bo_type_id:43,
template_id:14183,
name:
John Doe,
description:
Business Workspace of John Doe,
roles:{
rmclassifications:{
rmclassification_id:[276653],
status:
SECRET...SECRET,
status_date:
2021-06-04T00:00:00,
record_date:
2021-05-27T00:00:00,
rsi:
TEST,
official: true},
categories:{
14177:{
14177_3:
Germany,
14177_4:
High Tech}}}}
Example to update a late business workspace:
body={
ibo_workspace_id:
65443,
bo_id:
171971,
bo_type_id:43,
template_id:14183,
name:
John Doe,
description:
Business Workspace of John Doe,
roles:{
categories:{
14177:{
14177_3:
Germany,
14177_4:
High Tech}}}}
Example to create a business template:
body={
wksp_type_id:12,
parent_id: 78833,
name:
Test Workspace Template}
Request Body
[{"name"=>"Body", "value"=>"Lorem pariatur", "datatype"=>"string"}]
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"links":{"data":{"self":{"body":"occaecat elit aute","content_type":"minim adipisicing quis","href":"et Ut","method":"ull","name":"occaecat minim s"}}},"results":{"id":59215750}}