Create an Asset (Comment)
1 min
POST
{{BaseURL}}/repository/container/{{containerAID}}/{{containerVersion}}/asset
Path Parameters
- BaseURLstringDefaultBaseURL
- containerAIDstringDefaultcontainerAID
- containerVersionstringDefaultcontainerVersion
Body Parameters
- bodyobjectDefault{ "assetType": "COMMENT", "label": "Comment Label", "name": "Comment Name", "identifier": "COM_1", "description": [ { "locale": "", "text": "Comment description" }, { "locale": "fr-FR", "text": "Comment French description" } ], "clinicalStage": [ "Study setup", "Study conduct" ], "therapeuticArea": [ "Devices", "Hematology" ], "aliases": [ { "context": "RAVE", "name": "Comment Rave Alias", "orderNumber": 0 }, { "context": "SDTM", "name": "Comment SDTM Alias", "orderNumber": 1 } ], "comment": [ { "locale": "", "text": "Comment text" }, { "locale": "fr-FR", "text": "Comment French text" } ], "documents": [ { "aid": "{{fileAID}}", "orderNumber": 10, "pageRefs": [ { "orderNumber": 11, "pageNumber": "10", "pageRange": "", "title": "documentTitle", "destination": [] } ] } ] }
Responses
200
curl
curl --request POST \
--url {{BaseURL}}/repository/container/{{containerAID}}/{{containerVersion}}/asset \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '"{\r\n \"assetType\": \"COMMENT\",\r\n \"label\": \"Comment Label\",\r\n \"name\": \"Comment Name\",\r\n \"identifier\": \"COM_1\",\r\n \"description\": [\r\n {\r\n \"locale\": \"\",\r\n \"text\": \"Comment description\"\r\n },\r\n {\r\n \"locale\": \"fr-FR\",\r\n \"text\": \"Comment French description\"\r\n }\r\n ],\r\n \"clinicalStage\": [\r\n \"Study setup\",\r\n \"Study conduct\"\r\n ],\r\n \"therapeuticArea\": [\r\n \"Devices\",\r\n \"Hematology\"\r\n ],\r\n \"aliases\": [\r\n {\r\n \"context\": \"RAVE\",\r\n \"name\": \"Comment Rave Alias\",\r\n \"orderNumber\": 0\r\n },\r\n {\r\n \"context\": \"SDTM\",\r\n \"name\": \"Comment SDTM Alias\",\r\n \"orderNumber\": 1\r\n }\r\n ],\r\n \"comment\": [\r\n {\r\n \"locale\": \"\",\r\n \"text\": \"Comment text\"\r\n },\r\n {\r\n \"locale\": \"fr-FR\",\r\n \"text\": \"Comment French text\"\r\n }\r\n ],\r\n \"documents\": [\r\n {\r\n \"aid\": \"{{fileAID}}\",\r\n \"orderNumber\": 10,\r\n \"pageRefs\": [\r\n {\r\n \"orderNumber\": 11,\r\n \"pageNumber\": \"10\",\r\n \"pageRange\": \"\",\r\n \"title\": \"documentTitle\",\r\n \"destination\": []\r\n }\r\n ]\r\n }\r\n ]\r\n}"'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var raw = JSON.stringify("{\r\n \"assetType\": \"COMMENT\",\r\n \"label\": \"Comment Label\",\r\n \"name\": \"Comment Name\",\r\n \"identifier\": \"COM_1\",\r\n \"description\": [\r\n {\r\n \"locale\": \"\",\r\n \"text\": \"Comment description\"\r\n },\r\n {\r\n \"locale\": \"fr-FR\",\r\n \"text\": \"Comment French description\"\r\n }\r\n ],\r\n \"clinicalStage\": [\r\n \"Study setup\",\r\n \"Study conduct\"\r\n ],\r\n \"therapeuticArea\": [\r\n \"Devices\",\r\n \"Hematology\"\r\n ],\r\n \"aliases\": [\r\n {\r\n \"context\": \"RAVE\",\r\n \"name\": \"Comment Rave Alias\",\r\n \"orderNumber\": 0\r\n },\r\n {\r\n \"context\": \"SDTM\",\r\n \"name\": \"Comment SDTM Alias\",\r\n \"orderNumber\": 1\r\n }\r\n ],\r\n \"comment\": [\r\n {\r\n \"locale\": \"\",\r\n \"text\": \"Comment text\"\r\n },\r\n {\r\n \"locale\": \"fr-FR\",\r\n \"text\": \"Comment French text\"\r\n }\r\n ],\r\n \"documents\": [\r\n {\r\n \"aid\": \"{{fileAID}}\",\r\n \"orderNumber\": 10,\r\n \"pageRefs\": [\r\n {\r\n \"orderNumber\": 11,\r\n \"pageNumber\": \"10\",\r\n \"pageRange\": \"\",\r\n \"title\": \"documentTitle\",\r\n \"destination\": []\r\n }\r\n ]\r\n }\r\n ]\r\n}");
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("{{BaseURL}}/repository/container/{{containerAID}}/{{containerVersion}}/asset", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("{{BaseURL}}/repository/container/{{containerAID}}/{{containerVersion}}/asset")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump("{\r\n \"assetType\": \"COMMENT\",\r\n \"label\": \"Comment Label\",\r\n \"name\": \"Comment Name\",\r\n \"identifier\": \"COM_1\",\r\n \"description\": [\r\n {\r\n \"locale\": \"\",\r\n \"text\": \"Comment description\"\r\n },\r\n {\r\n \"locale\": \"fr-FR\",\r\n \"text\": \"Comment French description\"\r\n }\r\n ],\r\n \"clinicalStage\": [\r\n \"Study setup\",\r\n \"Study conduct\"\r\n ],\r\n \"therapeuticArea\": [\r\n \"Devices\",\r\n \"Hematology\"\r\n ],\r\n \"aliases\": [\r\n {\r\n \"context\": \"RAVE\",\r\n \"name\": \"Comment Rave Alias\",\r\n \"orderNumber\": 0\r\n },\r\n {\r\n \"context\": \"SDTM\",\r\n \"name\": \"Comment SDTM Alias\",\r\n \"orderNumber\": 1\r\n }\r\n ],\r\n \"comment\": [\r\n {\r\n \"locale\": \"\",\r\n \"text\": \"Comment text\"\r\n },\r\n {\r\n \"locale\": \"fr-FR\",\r\n \"text\": \"Comment French text\"\r\n }\r\n ],\r\n \"documents\": [\r\n {\r\n \"aid\": \"{{fileAID}}\",\r\n \"orderNumber\": 10,\r\n \"pageRefs\": [\r\n {\r\n \"orderNumber\": 11,\r\n \"pageNumber\": \"10\",\r\n \"pageRange\": \"\",\r\n \"title\": \"documentTitle\",\r\n \"destination\": []\r\n }\r\n ]\r\n }\r\n ]\r\n}")
response = http.request(request)
puts response.read_body
python
import requests
import json
url = "{{BaseURL}}/repository/container/{{containerAID}}/{{containerVersion}}/asset"
payload = json.dumps("{\r\n \"assetType\": \"COMMENT\",\r\n \"label\": \"Comment Label\",\r\n \"name\": \"Comment Name\",\r\n \"identifier\": \"COM_1\",\r\n \"description\": [\r\n {\r\n \"locale\": \"\",\r\n \"text\": \"Comment description\"\r\n },\r\n {\r\n \"locale\": \"fr-FR\",\r\n \"text\": \"Comment French description\"\r\n }\r\n ],\r\n \"clinicalStage\": [\r\n \"Study setup\",\r\n \"Study conduct\"\r\n ],\r\n \"therapeuticArea\": [\r\n \"Devices\",\r\n \"Hematology\"\r\n ],\r\n \"aliases\": [\r\n {\r\n \"context\": \"RAVE\",\r\n \"name\": \"Comment Rave Alias\",\r\n \"orderNumber\": 0\r\n },\r\n {\r\n \"context\": \"SDTM\",\r\n \"name\": \"Comment SDTM Alias\",\r\n \"orderNumber\": 1\r\n }\r\n ],\r\n \"comment\": [\r\n {\r\n \"locale\": \"\",\r\n \"text\": \"Comment text\"\r\n },\r\n {\r\n \"locale\": \"fr-FR\",\r\n \"text\": \"Comment French text\"\r\n }\r\n ],\r\n \"documents\": [\r\n {\r\n \"aid\": \"{{fileAID}}\",\r\n \"orderNumber\": 10,\r\n \"pageRefs\": [\r\n {\r\n \"orderNumber\": 11,\r\n \"pageNumber\": \"10\",\r\n \"pageRange\": \"\",\r\n \"title\": \"documentTitle\",\r\n \"destination\": []\r\n }\r\n ]\r\n }\r\n ]\r\n}")
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
200