Single Request Creation API
Builds a container in a single request instead of four separate calls. You can add links, files, and folders together, and seal the container right away if you want to.
Endpoint:
POST /create-full-rdmc/
Example 1: Mixed Upload, Not Sealed
Combines links, files, and folders across two artifacts. Any Status other
than "seal", including leaving it out, creates the container without
sealing it.
{
"RDMC Title": "Single Request - Mixed Create",
"Status": "create",
"Artifacts Details": [
{
"artifact_name": "Source_Code",
"access_level": "Public",
"links": [
{
"title": "Data Processing Script",
"resource type": "Software",
"link": "https://github.com/research-lab/climate-model"
}
]
},
{
"artifact_name": "Raw_Data",
"access_level": "Private",
"files": [
{
"title": "Station Configuration",
"resource type": "Data",
"file name": "C:/Research/Data/config.xml"
}
],
"folders": [
{
"title": "January Sensor Logs",
"resource type": "Data",
"folder name": "C:/Research/Data/january_logs"
}
]
}
],
"RDMC Metadata": {
"Contributors": [
{
"first_name": "Jane",
"last_name": "Doe",
"orcid": "0000-0002-1825-0097",
"affiliation": "Institute for Computer Science",
"role": "Lead Developer"
}
],
"License": "MIT",
"Keywords": "Automation, API, Testing",
"Description": "Container built from local files, folders, and a link.",
"Subject": "Computer and Information Science"
}
}
Expected Response (201 Created)
{
"success": true,
"container_id": "niBWYGu6",
"message": "RDMC created successfully. It has not been sealed yet.",
"warnings": [],
"seal_details": {}
}
Example 2: Mixed Upload and Seal
Setting "Status": "seal" seals the container right after it is built. This
hashes the files, generates the manifest, and creates the EPIC PID.
{
"RDMC Title": "Single Request - Mixed and Sealed",
"Status": "seal",
"Artifacts Details": [
{
"artifact_name": "Documentation",
"access_level": "Public",
"links": [
{
"title": "Project Wiki",
"resource type": "Text",
"link": "https://github.com/research-lab/climate-model"
}
]
},
{
"artifact_name": "Compiled_Binaries",
"access_level": "Restricted",
"files": [
{
"title": "Release v1.0",
"resource type": "Software",
"file name": "C:/Research/Build/app_v1.exe"
}
],
"folders": [
{
"title": "Support Libraries",
"resource type": "Software",
"folder name": "C:/Research/Build/libs"
}
]
}
],
"RDMC Metadata": {
"Contributors": [
{
"first_name": "Jane",
"last_name": "Doe",
"affiliation": "Institute for Computer Science",
"orcid": "0000-0002-1825-0097",
"role": "Lead Developer"
}
],
"License": "MIT",
"Keywords": "Automation, API, Testing",
"Description": "Final sealed release of the application.",
"Subject": "Computer and Information Science"
}
}
Expected Response (201 Created)
{
"success": true,
"container_id": "niBWYGu6",
"message": "RDMC created and sealed successfully.",
"warnings": [],
"seal_details": {
"epic_pid": "21.11113/0000-0000-0000-0000",
"signature": "base64_encoded_signature_string_here",
"sealed": true
}
}
seal_details is always present. It is an empty object, {}, unless
you set "Status": "seal". warnings lists any non-fatal issues found
while uploading. An empty list means there were none.
Note
If anything fails while building the container, such as a bad link, a missing file, or invalid metadata, the whole container is rolled back and deleted. Nothing is left behind, so no manual cleanup is required.
Integration Guide
The example below uses curl. Any language that can send HTTP requests
can make the same call.
curl -X POST https://api.nfdixcs.org/rdmc_creation/create-full-rdmc/ \
-H "Authorization: Token <your_token>" \
-H "Content-Type: application/json" \
-d '{
"RDMC Title": "Single Request - Mixed and Sealed",
"Status": "seal",
"Artifacts Details": [
{
"artifact_name": "Documentation",
"access_level": "Public",
"links": [
{"title": "Project Wiki", "resource type": "Text",
"link": "https://github.com/research-lab/climate-model"}
]
}
],
"RDMC Metadata": {
"Description": "Final sealed release of the application."
}
}'
Important Note on Files and Folders:
The curl example above sends links only, so a plain application/json body is enough. The local paths (like C:/Research/Build/app_v1.exe) shown in the earlier JSON examples only work if the server itself has access to those exact local paths.
To upload actual files and folders from your own computer to a remote server, you must send the request as multipart/form-data with these parts:
manifest: the JSON body as text.files: one binary part for each file listed underfiles.folder_zip: one binary part for each folder listed underfolders. Each folder is sent as a zip archive that contains the folder under its own name.
Because constructing this multipart request and zipping directories manually can be complex, we strongly recommend using the provided Python client for file and folder uploads. It automatically reads the paths on your computer, zips the folders, and uploads the content correctly.
👉 View full_create_rdmc_api.py on GitLab
Check the response: container_id confirms the container was created,
and seal_details tells you whether it was sealed. On failure, nothing
is created, and no manual cleanup is required.