nodes_samples_batch_create
const url = 'https://example.com/api/nodes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/samples/batch';const options = { method: 'POST', headers: { 'X-Workspace': '2489E9AD-2EE2-8E00-8EC9-32D5F69181C0', Authorization: 'Bearer <token>', 'Content-Type': 'application/json' }, body: '{"samples":["example"]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/nodes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/samples/batch \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'X-Workspace: 2489E9AD-2EE2-8E00-8EC9-32D5F69181C0' \ --data '{ "samples": [ "example" ] }'Create several samples in the node, in a single request.
Each sample is created or refused on its own: a refused sample does not
stop the others, and nothing is undone. results follows the order of
the request and tells, for each sample, whether it was created and, when
it was not, the error that prevented it.
The alias of a sample is unique in its node. A sample is refused with
alias_taken when another sample of the node uses its alias, and with
alias_repeated when an earlier sample of the batch has it; the earlier
one is created. A sample whose title or alias is not valid is refused with
the code of the field validation. Sending the refused samples again, once
corrected, creates them.
The answer is a 201 when at least one sample was created, a 200 otherwise.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Header Parameters
Section titled “Header Parameters”Workspace ID
Request Bodyrequired
Section titled “Request Bodyrequired”Serializer for the creation of a batch of samples.
Only the list itself is checked here. Each sample is checked on its own, so that an invalid one is refused in the report instead of failing the batch.
object
The samples to create, each as {title, alias}.
Example generated
{ "samples": [ "example" ]}Serializer for the creation of a batch of samples.
Only the list itself is checked here. Each sample is checked on its own, so that an invalid one is refused in the report instead of failing the batch.
object
The samples to create, each as {title, alias}.
Example generated
samples=exampleSerializer for the creation of a batch of samples.
Only the list itself is checked here. Each sample is checked on its own, so that an invalid one is refused in the report instead of failing the batch.
object
The samples to create, each as {title, alias}.
Responses
Section titled “Responses”Serializer for the answer to the creation of a batch of samples.
object
Serializer for what became of one sample of a batch.
object
The title as it was sent.
The alias as it was sent.
Null when not created.
object
Determine source of object as either ‘local’, ‘inherited’, or ‘descendant’.
The function checks if the given object is:
local: if it is not associated with the current node’s ancestors or descendants.inherited: if it is associated with one of the ancestors of the current node.descendant: if it is associated with one of the descendants of the current node.
Parameters
obj : Sample Object being checked for its source.
Returns
source : str Source of object: - “inherited”: if object is from ancestor node. - “descendant”: if object is from descendant node. - “local”: if object is not associated with current node’s ancestors or descendants.
Return information about a given object, including the count of bound samples and a related URL.
Parameters
obj : Sample Object containing information about a sample.
Returns
dict
Dictionary containing:
- “count”: The count of bound samples for the given object (obj).
- “related”: The URL for accessing bound data related to the object.
object
Return information about bound datalinks related to a given object.
The method retrieves information about bound datalinks associated with the object, including the count of distinct datalink values and a URL for accessing the bound datalinks.
Parameters
obj : Sample Object containing information about a sample.
Returns
dict
Dictionary containing:
- “count”: The number of distinct values in the “datalink” field
of the bound_data related to the given obj.
- “related”: The URL for accessing the bound datalinks related to
the given obj.
object
Return interactor information of the object’s creator.
Parameters
obj : Sample Object containing the creator information.
Returns
dict Interactor information of the creator.
object
Return information about the last interactor who edited the object.
Parameters
obj : Sample Object containing the last editor information.
Returns
dict Interactor information of the last editor.
object
Why the sample was not created. Null when it was.
object
The field at fault.
alias_taken when another sample of the node uses the alias, alias_repeated when an earlier sample of the batch has it, or the code of the field validation (required, invalid, blank, max_length).
Example generated
{ "created": 1, "failed": 1, "results": [ { "title": "example", "alias": "example", "created": true, "sample": { "alias": "example", "title": "example", "node": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }, "error": { "parameter": "example", "code": "example", "message": "example" } } ]}Serializer for the answer to the creation of a batch of samples.
object
Serializer for what became of one sample of a batch.
object
The title as it was sent.
The alias as it was sent.
Null when not created.
object
Determine source of object as either ‘local’, ‘inherited’, or ‘descendant’.
The function checks if the given object is:
local: if it is not associated with the current node’s ancestors or descendants.inherited: if it is associated with one of the ancestors of the current node.descendant: if it is associated with one of the descendants of the current node.
Parameters
obj : Sample Object being checked for its source.
Returns
source : str Source of object: - “inherited”: if object is from ancestor node. - “descendant”: if object is from descendant node. - “local”: if object is not associated with current node’s ancestors or descendants.
Return information about a given object, including the count of bound samples and a related URL.
Parameters
obj : Sample Object containing information about a sample.
Returns
dict
Dictionary containing:
- “count”: The count of bound samples for the given object (obj).
- “related”: The URL for accessing bound data related to the object.
object
Return information about bound datalinks related to a given object.
The method retrieves information about bound datalinks associated with the object, including the count of distinct datalink values and a URL for accessing the bound datalinks.
Parameters
obj : Sample Object containing information about a sample.
Returns
dict
Dictionary containing:
- “count”: The number of distinct values in the “datalink” field
of the bound_data related to the given obj.
- “related”: The URL for accessing the bound datalinks related to
the given obj.
object
Return interactor information of the object’s creator.
Parameters
obj : Sample Object containing the creator information.
Returns
dict Interactor information of the creator.
object
Return information about the last interactor who edited the object.
Parameters
obj : Sample Object containing the last editor information.
Returns
dict Interactor information of the last editor.
object
Why the sample was not created. Null when it was.
object
The field at fault.
alias_taken when another sample of the node uses the alias, alias_repeated when an earlier sample of the batch has it, or the code of the field validation (required, invalid, blank, max_length).
Example generated
{ "created": 1, "failed": 1, "results": [ { "title": "example", "alias": "example", "created": true, "sample": { "alias": "example", "title": "example", "node": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }, "error": { "parameter": "example", "code": "example", "message": "example" } } ]}object
object
Example
{ "code": "body_validation_error", "message": "The request body does not match the schema for the expected parameters. Check the `details` property for more details.", "details": [ { "parameter": "samples", "code": "invalid", "message": "A batch holds at most <max> samples, <n> were given." } ]}object
object
Example
{ "code": "forbidden", "message": "You do not have permission to perform this operation. Check the `details` property for more details.", "details": [ { "parameter": "node", "code": "permission_denied", "message": "Your role does not allow creation for this node." } ]}object
object
Example
{ "code": "object_not_found", "message": "Object not found. Check the `details` property for more details.", "details": [ { "parameter": "<id>", "code": "does_not_exist", "message": "\"<id>\" does not exist." } ]}object
object
Example
{ "code": "node_operation_in_progress", "message": "The requested operation cannot be performed because the node is currently in progress.", "details": [ { "parameter": "node", "code": "in_progress", "message": "Node '<node id>' is currently in progress and cannot perform operation 'create_sample'." } ]}
