Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: improve bulk list update documentation #2

Merged
merged 1 commit into from
Oct 29, 2024
Merged

chore: improve bulk list update documentation #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 5 additions & 8 deletions source/index.html.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1027,7 +1027,9 @@ Remember — user your own header Authorization

## Bulk Update List Elements

This endpoint allows bulk updating of metadata list objects, with soft deletion of objects not in the incoming list.
This endpoint allows bulk updating of metadata list objects, with soft deletion of objects not in the incoming list. If an object with an existing code is provided, it will be updated. If a new code is used, the object will be created.

> **Warning**: This operation will delete all existing objects for the specified metadata_type and replace them with the new objects provided. This endpoint is currently in an **experimental stage**. Changes may be made to functionality or structure as we continue testing and refining its implementation.

```ruby
require 'rest-client'
Expand All @@ -1036,7 +1038,7 @@ require 'json'
url = 'https://www.mydatascope.com/api/external/metadata_objects/bulk_update'
response = RestClient.post url, {
metadata_type: "DATASCOPE_SAFETY_LIST_CODE",
objects: [
list_objects: [
{
code: "PPE001",
name: "Helmet",
Expand Down Expand Up @@ -1072,7 +1074,7 @@ curl "https://www.mydatascope.com/api/external/metadata_objects/bulk_update"
-X POST
-d '{
"metadata_type": "DATASCOPE_SAFETY_LIST_CODE",
"objects": [
"list_objects": [
{
"code": "PPE001",
"name": "Helmet",
Expand Down Expand Up @@ -1111,8 +1113,6 @@ curl "https://www.mydatascope.com/api/external/metadata_objects/bulk_update"
}
```

This endpoint updates multiple list objects in bulk.

### HTTP Request

`POST https://www.mydatascope.com/api/external/metadata_objects/bulk_update`
Expand Down Expand Up @@ -1163,9 +1163,6 @@ The response includes:
Remember — user your own header Authorization
</aside>

> **Warning**: This operation will delete all existing objects for the specified metadata_type and replace them with the new objects provided. This endpoint is currently in an **experimental stage**. Changes may be made to functionality or structure as we continue testing and refining its implementation. Use with caution, and consider testing thoroughly in your environment before relying on it in production.


# Task Assigns

## Create Task Assign
Expand Down
Loading