Category – 3D Spark Blog

Create ComboCategoryItem (POST)

Create ComboCategory, ComboCategoryItem and Organization

Form Data

Parameter	Description	Required	Type	Valid Values	user-role
category	Label of the category	false	string	1-250	manager
required	Flag if the category is required	false	bool	TRUE, FALSE, “true”, “false” (all cases)	manager
item	CategoryItem value to be created	false	str	1-250	manager

Return Data

{
    "message": "Added category choice: 3D Spark | Status | pending (6ba40dc05533401caa9f47f014efd1f8)",
}

Errors

Precondition	Status code	Error message
User is in an organization	400	<username> not in any organization.
User is manager of ComboCategoryItem organization	403	Access forbidden.
category / required / item field is invalid	422	Invalid user input.

Usage

# POST "https://platform.3dspark.de/api/v1/combo-category-item/"

let formData = {
  "category": "Status",
  "required": true,
  "item": "pending",
}
this.axiosInstance
  .post("/api/v1/combo-category-item/", formData)
  .then((response) => {
    console.log(response.data);
  })

Update ComboCategoryItem (PUT)

Update ComboCategory label and/or required state

Form Data

Parameter	Description	Required	Type	Valid Values	user-role
value	New Label of the item	false	string	1-250	manager
required	Flag if the category is required	false	bool	TRUE, FALSE, “true”, “false” (all cases)	manager

Return Data

{
    "message": Updated ComboCategoryItem  6ba40dc05533401caa9f47f014efd1f8",
}

Errors

Precondition	Status code	Error message
ComboCategoryItem exists	404	ComboCategoryItem with UID <uid> not found.
User is manager of ComboCategoryItem organization	403	Access forbidden.
category / required / item field invalid	422	Invalid user input.

Usage

# PUT "https://platform.3dspark.de/api/v1/combo-category-item/6ba40dc05533401caa9f47f014efd1f8/"

let formData = {
  "value": "running",
}
this.axiosInstance
  .put("/api/v1/combo-category-item/6ba40dc05533401caa9f47f014efd1f8/", formData)
  .then((response) => {
    console.log(response.data);
  })

Delete ComboCategoryItem (DELETE)

Delete ComboCategoryItem and ComboCategory, if empty afterwards.

Return Data

{
    "message": "Deleted ComboCategoryItem: 6ba40dc05533401caa9f47f014efd1f8",
}

Errors

Precondition	Status code	Error message
ComboCategoryItem exists	404	ComboCategoryItem with UID <uid> not found.
User is manager of ComboCategoryItem organization	403	Access forbidden.

Usage

# DELETE "https://platform.3dspark.de/api/v1/combo-category-item/<combo-category-item_uid>/"

this.axiosInstance
  .delete("/api/v1/combo-category-item/6ba40dc05533401caa9f47f014efd1f8/")
  .then((response) => {
    console.log(response.data);
  })

Update ComboCategory (PUT)

Update ComboCategory label and/or required state.

Form Data

Parameter	Description	Required	Type	Valid Values	user-role
label	New Label of the item	false	string	1-250	manager
required	Flag if the category is required	false	bool		manager

Create ComboCategory Parameters

Return Data

{
    "message": Updated ComboCategory  6ba40dc05533401caa9f47f014efd1f8",
}

Errors

Precondition	Status code	Error message
UID of ComboCategory passed	400	No UID specified.
ComboCategory exists	404	ComboCategory with UID <uid> not found.
User is manager of ComboCategoryItem organization	403	Access forbidden.
label / required field invalid	422	No valid arguments given.

Usage

# PUT "https://platform.3dspark.de/api/v1/combo-category/6ba40dc05533401caa9f47f014efd1f8/"

let formData = {
  "label": "status",
  "required": true,
}
this.axiosInstance
  .put("/api/v1/combo-category/6ba40dc05533401caa9f47f014efd1f8/", formData)
  .then((response) => {
    console.log(response.data);
  })

Delete ComboCategory (DELETE)

Delete ComboCategory and all items.

Return Data

{
    "message": Deleted ComboCategory:  6ba40dc05533401caa9f47f014efd1f8",
}

Errors

Precondition	Status code	Error message
valid ComboCategory UID passed	422	Invalid user input.
ComboCategory exists	404	ComboCategory with UID <uid> not found.
User is manager of ComboCategory organization	403	Access forbidden.

Usage

# DELETE "https://platform.3dspark.de/api/v1/combo-category/6ba40dc05533401caa9f47f014efd1f8/"
this.axiosInstance
  .delete("/api/v1/combo-category/6ba40dc05533401caa9f47f014efd1f8/")
  .then((response) => {
    console.log(response.data);
  })

Create TextCategory (POST)

Create TextCategory and TextCategoryItem

Form Data

Parameter	Description	Required	Type	Valid Values	user-role
category	Label of the category	false	string	1-250	manager
required	Flag if the category is required	false	bool	TRUE, FALSE, “true”, “false” (all cases)	manager

Return Data

{
    "message": "Added category choice: 3D Spark | Location",
}

Errors

Precondition	Status code	Error message
User is in an organization	400	<username> not in any organization.
User is manager of ComboCategory organization	403	Access forbidden.
category / required field invalid	422	Invalid user input.

Usage

# POST "https://platform.3dspark.de/api/v1/text-category-item/"

let formData = {
  "category": "Location",
  "required": true,
}
this.axiosInstance
  .post("/api/v1/combo-category-item/", formData)
  .then((response) => {
    console.log(response.data);
  })

Update TextCategory (PUT)

Update TextCategory value and/or required state.

Form Data

Parameter	Description	Required	Type	Valid Values	user-role
label	New Label of the item	false	string	1-250	manager
required	Flag if the category is required	false	bool	TRUE, FALSE, “true”, “false” (all cases)	manager

Return Data

{
    "message": Updated TextCategory  6ba40dc05533401caa9f47f014efd1f8",
}

Errors

Precondition	Status code	Error message
ComboCategoryItem exists	404	ComboCategoryItem with UID <uid> not found.
User is manager of ComboCategoryItem organization	403	Access forbidden.
label / required field invalid	422	Invalid user input.

Usage

# PUT "https://platform.3dspark.de/api/v1/text-category/6ba40dc05533401caa9f47f014efd1f8/"

let formData = {
  "required": true,
}
this.axiosInstance
  .put("/api/v1/text-category-item/6ba40dc05533401caa9f47f014efd1f8/", formData)
  .then((response) => {
    console.log(response.data);
  })

Delete TextCategory (DELETE)

Delete ComboCategory and all items.

Return Data

{
    "message": Deleted ComboCategory:  6ba40dc05533401caa9f47f014efd1f8",
}

Errors

Precondition	Status code	Error message
valid TextCategory UID passed	422	Invalid user input.
TextCategory exists	404	TextCategory with UID <uid> not found.
User is manager of TextCategory organization	403	Access forbidden.

Usage

# DELETE "https://platform.3dspark.de/api/v1/text-category/6ba40dc05533401caa9f47f014efd1f8/"
this.axiosInstance
  .delete("/api/v1/text-category/6ba40dc05533401caa9f47f014efd1f8/")
  .then((response) => {
    console.log(response.data);
  })