Metadata

retrieve a list of standards/studies this request returns a list of standards/studies and their versions within the system the resultant lists are grouped by the unique administered id aid for the standard/study endpoint get https //ryze formedix com/fws/api/repository/container example response \[ { "aid" "01234567 89ab cdef 0123 456789abcdef", "versions" \[ { "version" 0, "label" "", "name" "", "identifier" "", "versionlabel" "", "containertype" "study", "updated" "ccyymmddthhmmss sssz", "status" "", "category" "not in use" }, ] }, ] containertype can be either a study or standard category can be not in use, production, rejected, in review, in progress, draft errors see docid\ tqpncp50s5muu3bfnmk9w retrieve details for a standard/study return a detailed version of the standard/study, including the owner, updated time, and rule compliance along with other standard or study details request get https //ryze formedix com/fws/api/repository/container/containeraid/version response { "uuid" "e016fadb bc81 4fe3 9ce3 feedcaeced24", "aid" "e016fadb bc81 4fe3 9ce3 feedcaeced24", "updated" "20230523t192843 439z", "containertype" "study", "version" 1, "versionlabel" "", "label" "", "name" "", "identifier" "", "therapeuticarea" \[ "" ], "sponsor" "", "program" "", "protocolid" "", "protocolname" "", "protocoltitle" "", "status" "draft", "category" "draft", "owner" "", "rulecompliance" { "compliant" 0, "deviation" 0, "nonstandard" 0 }, "assetstatus" \[ { "category" "production", "name" "production", "total" 20 } ] } containertype can be either study or standard assetstatus contains the total count of assets for each lifecycle state category can be not in use, production, rejected, in review, in progress, draft versionlabel , name , sponsor and program are optional protocolid , protocolname and protocoltitle are for study containers only owner is the username of the user that created the container http status error code description 400 invalid container aid an invalid administeredid was specified as the containeraid 400 invalid container version a non numeric value was specified as the version errors see docid\ tqpncp50s5muu3bfnmk9w create a standard or study this request can be used to create a standard or study endpoint post https //ryze formedix com/fws/api/repository/container example request { "containertype" "study", "versionlabel" "", "label" "", "name" "", "identifier" "", "description" \[ { "locale" "", "text" "" }, ], "therapeuticarea" \[ "", ], "sponsor" "", "program" "", "protocolid" "", "protocolname" "", "protocoltitle" "", "owner" "" } request parameters accepted values containertype \[mandatory] standard, study versionlabel \[optional] label \[mandatory] name \[optional] identifier \[mandatory] description \[optional] therapeuticarea \[optional] sponsor \[optional] program \[optional] protocolid \[optional] protocolname \[optional] protocoltitle \[optional] owner \[mandatory] uuid of the user to be specified as the owner containertype can be either standard or study protocolid , protocolname and protocoltitle are properties for studies if added to a request to create a standard, they are ignored owner is used to assign a user ownership of the standard/study this allows the user to make changes in the application you can use the docid\ g4gjabut0recgnyi6bwfk request to find the uuid of the user to be set as the owner example response { "aid" "01234567 89ab cdef 0123 456789abcdef", "version" 0 } errors http status error code 400 invalid container type unrecognized containertype provided 400 value cannot be empty empty label or identifier provided 404 unknown user user specified as owner does not exist see also docid\ tqpncp50s5muu3bfnmk9w retrieve a list of asset groups for a standard/study replace containeraid and version with your values request get https //ryze formedix com/fws/api/repository/container/containeraid/version/assetgroup this request returns a list of asset groups within a standard/study in the system you should get a list of standards/studies and their versions beforehand then choose the appropriate one to use in this request a summary of rule compliance is returned for each asset group assetstatus contains the total count of assets for each lifecycle state category can be not in use, production, rejected, in review, in progress, draft list of possible asset group types adam sdtm send data acquisition source dataset (i e data) dataset you can use containeraid and version to specify which standard/study to retrieve the asset groups for example response \[ { "aid" "01234567 89ab cdef 0123 456789abcdef", "label" "", "name" "", "identifier" "", "updated" "ccyymmddthhmmss sssz", "assetgrouptype" "dataset", "rulecompliance" { "compliant" 0, "deviation" 0, "nonstandard" 0 }, 	"assetstatus" \[ { "category" "", "name" "", "total" 0 }, ] }, ] errors http status error code 400 invalid container aid an invalid administeredid was specified as the containeraid 400 invalid container version a non numeric value was specified as the version 404 unknown container unknown containeraid / version pair see also docid\ tqpncp50s5muu3bfnmk9w create an asset group add a new asset group to an existing standard or study you can use containeraid and version to specify the standard/study to add the asset group to replace containeraid and version with your values post https //ryze formedix com/fws/api/repository/container/containeraid/version/assetgroup example request { "assetgrouptype" "sdtm", "label" "", "name" "", "identifier" "", "standardname" "", "standardversion" "", "forsubmission" true } request parameters accepted values assetgrouptype data acquisition, sdtm, send, adam, dataset, generic name , standardname , standardversion and forsubmission are optional fields the fields standardname , standardversion and forsubmission are for dataset asset group types only (dataset, sdtm, send, adam) if these fields are supplied for another type of asset group, then an error is returned example response { "aid" "01234567 89ab cdef 0123 456789abcdef" } errors http status error code 400 invalid assetgroup type unrecognized assetgrouptype supplied 400 incompatible property one of ( standardname , standardversion , forsubmission ) have been supplied for a non dataset asset group 400 invalid workflow state container is in a non editable state 400 value cannot be empty empty label or identifier provided 400 invalid container aid an invalid administeredid was specified as the containeraid 400 invalid container version a non numeric value was specified as the version 404 unknown container unknown containeraid / version pair see also docid\ tqpncp50s5muu3bfnmk9w retrieve a list of assets for an asset group in a standard/study replace containeraid , version , and assetgroupaid with your values request get https //ryze formedix com/fws/api/repository/container/containeraid/version/assetgroup/assetgroupaid/asset this request returns a list of assets within an asset group for a standard/study in the system the response may be 'chunked' into partial results, depending on size the rule compliance type of each asset is returned assetstatus contains the total count of assets for each lifecycle state category can be not in use, production, rejected, in review, in progress, draft before making this request, you should first get a list of standards/studies and their versions, then get a list of asset groups for one standard/study you can use containeraid and version to specify the standard/study, and assetgroupaid to specify the asset group to retrieve the assets for example response \[ { "aid" "01234567 89ab cdef 0123 456789abcdef", "label" "", "name" "", "identifier" "", "updated" "ccyymmddthhmmss sssz", "assettype" "dataset", "alias" \[ { "context" "", "name" "", "ordernumber" 0 }, 	 ], "description" \[ { "locale" "", "text" "", "ordernumber" 0 }, ], "therapeuticarea" \[ "", ], "clinicalstage" \[ "", ], "rulecompliance" "compliance", "assetstatus" { "name" "", "category" "" } }, ] the response returns a list of possible assets and includes the assettype , for example form, section, question, term, method, variable, comment, etc errors http status error code 400 invalid container aid an invalid administeredid was specified as the containeraid 400 invalid container version a non numeric value was specified as the version 404 unknown container unknown containeraid / version pair 404 unknown assetgroup unknown assetgroupaid within the containeraid / version pair see also docid\ tqpncp50s5muu3bfnmk9w retrieve a list of assets for an asset group filtered by asset type request get https //ryze formedix com/fws/api/repository/container/containeraid/containerversion/assetgroup/assetgroupaid/assettype return a list of assets in an asset group which has been filtered by the specified asset type containeraid and containerversion specify the container in which the asset group exists assetgroupaid specifies the asset group being filtered the assettype can be visit , form , dataset , terminology or file assetstatus contains the total count of assets for each lifecycle state category can be not in use, production, rejected, in review, in progress, draft response \[ { "aid" "da742a14 9b6c 4e23 bf86 74ec29ec7da3", "label" "", "name" "”, "identifier" "", "updated" "20230101t010203 456z", "assettype" "form", "alias" \[ { "context" "", "name" "", "ordernumber" 0 }, 	 ], "description" \[ { "locale" "", "text" "", 	 "ordernumber" 0 }, ], "therapeuticarea" \[ "", ], "clinicalstage" \[ "", ], "rulecompliance" "nonstandard", "assetstatus" { "name" "", "category" "" } }, ] errors http status error code 400 invalid container aid an invalid administeredid was specified as the containeraid 400 invalid container version a non numeric value was specified as the version 400 invalid assetgroup aid an invalid administeredid was specified as the assetgroupaid 400 asset type not supported asset type not one of the following visit , form , dataset , terminology or file 404 unknown container could not find specified container using provided containeraid / version pair 404 unknown asset group could not find specified asset group with provided assetgroupaid see also docid\ tqpncp50s5muu3bfnmk9w create an asset endpoint post https //ryze formedix com/fws/api/repository/container/containeraid/version/asset replace containeraid and version with your values when creating assets, it is recommended that you start with the lowest level of referenced asset for example, if you are creating a section which references questions; then you must create the question assets first, either in the ui or by using the api similarly, if the question assets reference a terminology, then the terminology must be created first it may be easier to create and manage lower level assets in ryze instead of creating them in the api example request { "assettype" "section", "label" "section label", "name" "section name", "identifier" "s 1", "description" \[ { "locale" "", "text" "section description" }, { "locale" "fr fr", "text" "section french description" } ], "aliases" \[ { "context" "rave", "name" "section rave alias" }, { "context" "sdtm", "name" "section sdtm alias" } ], "clinicalstage" \[ "study setup" ], "therapeuticarea" \[ "devices", "hematology" ], "repeating" true, "repeat" { "repeattype" "simple", "simplerepeats" 2, "repeatquestion" "{{questionaid}}", "repeatsperterm" 1, "otherquestion" "{{questionaid}}", "otherterms" \[ "{{termaid}}" ] }, "questions" \[ { "aid" "{{questionaid}}", "ordernumber" 5, "mandatory" true, "condition" "{{conditionaid}}", "method" "{{methodaid}}" } ] } create an asset within a standard/study you can use containeraid and version to specify the container example response { “aid” “01234567 89ab cdef 0123 456789abcdef” } request parameters accepted values assettype \[mandatory] visit schedule, visit, form, section, question, condition, method, unit, dataset, variable, value, selection criteria, result display, analysis result, terminology, term, comment, file or link label \[mandatory] name \[optional] identifier \[mandatory] clinicalstage \[optional] therapeuticarea \[optional] description properties description description \[optional] locale \[optional] text \[optional] aliases properties description aliases \[optional] context \[optional] name \[optional] ordernumber \[optional] the following properties are applicable depending on the assettype and must be appended to the previous request properties are split by asset type and each asset type includes details of it's restrictions and optionality { visits \[ { "aid" "01234567 89ab cdef 0123 456789abcdef", "ordernumber" 0, "mandatory" true, "condition" "01234567 89ab cdef 0123 456789abcdef" }, ] } errors http status error code 400 value cannot be empty empty label or identifier provided or empty code provided for term asset 400 invalid class type classtype provided for dataset asset is not one of the required values 400 invalid comparator comparator provided for question or selection criteria asset is not one of the required values 400 invalid data type datatype provided for question , variable , value , terminology or method asset is not one of the required values 400 invalid order number a duplicate ordernumber has been included 400 invalid origin type origintype provided for variable or value asset is not one of the required values 400 invalid repeat type repeattype provided for section asset is not one of the required values 400 invalid severity severity provided for question asset is not one of the required values 400 invalid source source provided for variable or value asset is not one of the required values 400 invalid visit type visittype provided for visit asset is not one of the required values 400 invalid workflow state container is not editable 400 invalid term properties externaldictionary and terms have both been provided for a terminology asset 400 invalid container aid an invalid administeredid was specified as the containeraid 400 invalid container version a non numeric value was specified as the version 404 unknown asset referenced an asset of this type with this aid cannot be found returned when an asset attempts to reference a child asset that does not exist, e g a form references a section but a section with that aid cannot be found 404 unknown container unknown containeraid / version pair see also docid\ tqpncp50s5muu3bfnmk9w visit schedule request parameters description aid the aid of an existing visit ordernumber should be unique in the list mandatory \[optional] specifies if the property is mandatory condition \[optional] the aid of an existing condition visit { repeating true, visittype "scheduled", category "", forms \[ { "aid" "01234567 89ab cdef 0123 456789abcdef", "ordernumber" 0, "mandatory" true, "condition" "01234567 89ab cdef 0123 456789abcdef" }, ] } request parameters description repeating \[optional] visittype must be scheduled, unscheduled or common category \[optional] forms \[optional] aid the aid of an existing form ordernumber should be unique in the list mandatory \[optional] specifies if the property is mandatory condition \[optional] the aid of an existing condition form { "repeating" true, "sections" \[ { "aid" "01234567 89ab cdef 0123 456789abcdef", "ordernumber" 0, "mandatory" true, "condition" "01234567 89ab cdef 0123 456789abcdef" }, ] } request parameters description aid the aid of an existing section ordernumber should be unique in the list mandatory \[optional] specifies if the property is mandatory condition \[optional] the aid of an existing condition section { "repeating" true, "repeat" { "repeattype" "simple", "simplerepeats" 0, "repeatquestion" "01234567 89ab cdef 0123 456789abcdef", "repeatsperterm" 0, "otherquestion" "01234567 89ab cdef 0123 456789abcdef", "otherterms" \[ "01234567 89ab cdef 0123 456789abcdef", ] }, "questions" \[ { "aid" "01234567 89ab cdef 0123 456789abcdef", "ordernumber" 0, "mandatory" true, "condition" "01234567 89ab cdef 0123 456789abcdef", "method" "01234567 89ab cdef 0123 456789abcdef", }, ] } request parameters description repeating \[optional] repeat \[optional] repeat properties description repeattype must be simple or terminology simplerepeats \[optional] repeatquestion \[optional] aid of an existing question repeatsperterm \[optional] otherquestion \[optional] aid of an existing question otherterms \[optional] a list of aids of existing terms question properties description questions \[optional] category \[optional] aid the aid of an existing question ordernumber should be unique in the list mandatory \[optional] specifies if the property is mandatory condition \[optional] the aid of an existing condition method \[optional] the aid of an existing method question { "datatype" "text", "question" \[ { "locale" "", "text" "" }, ], "length" 0, "fractiondigits" 0, "submissionvariable" "", "rangechecks" \[ { "severity" "soft", "comparator" "lt", "values" \[ { "value" "", "aid" "01234567 89ab cdef 0123 456789abcdef" }, ], "formalexpressions" \[ { "context" "", "expression" "" }, ], "errormessage" \[ { "locale" "", "text" "" }, ] }, ], "terminology" "01234567 89ab cdef 0123 456789abcdef", "units" \[ { "aid" "01234567 89ab cdef 0123 456789abcdef", "ordernumber" 0 }, ] } request parameters description datatype must be one of the following text, integer, float, date, time, datetime, string, boolean, double, hexbinary, base64binary, hexfloat, base64float, partialdate, partialtime, partialdatetime, durationdatetime, intervaldatetime, incompletedatetime, incompletedate, incompletetime, uri question \[optional] length \[optional] fractiondigits \[optional] submissionvariable \[optional] terminology \[optional] the aid of an existing terminology rangecheck properties description rangechecks \[optional] severity must be soft or hard comparator lt, le, gt, ge, eq, ne, in, notin unit \[optional] the aid of an existing unit values \[optional] list of strings with aid as the aid of an existing unit formalexpressions \[optional] errormessage \[optional] unit properties description units \[optional] aid the aid of an existing unit ordernumber should be unique in the list { "symbol" \[ { "locale" "", "text" "" }, ] } unit request parameters description symbol \[optional] condition { "formalexpressions" \[ { "context" "", "expression" "" }, ] } request parameters description formalexpressions \[optional] method { "datatype" "computation", "formalexpressions" \[ { "context" "", "expression" "" }, ] "documents" \[ { "aid" "01234567 89ab cdef 0123 456789abcdef", "ordernumber" 0, "pagerefs" \[ { "ordernumber" 0, "pagenumber" "", "pagerange" "", "title" "", "destination" \[ "", ] }, ] }, ] } request parameters description formalexpressions \[optional] datatype must be computation, imputation, transpose or other documents \[optional] documents properties description aid the aid of an existing file ordernumber must be unique in the list pageref properties description pageref \[optional] ordernumber \[optional] must be unique in the list pagenumber \[optional] pagerange \[optional] title \[optional] destination \[optional] dataset { , "domain" "", "class" { "classtype" "events", "subclass" { "subclass" "", "subsubclass" { "subclass" "", "subsubclass" { } 	 } } }, "repeating" true, "structure" "", "purpose" "", "referencedata" true, "location" "", "comment" "01234567 89ab cdef 0123 456789abcdef", "variables" \[ { "aid" "01234567 89ab cdef 0123 456789abcdef", "ordernumber" 0, "mandatory" true, "keysequence" 0, "role" "", "method" "01234567 89ab cdef 0123 456789abcdef", "hasnodata" "", "nonstandard" "" } ], "hasnodata" "" } request parameters description domain \[optional] class classtype contains class type object must be one of trial design, special purpose, interventions, events, findings, findings about, relationship, wildcard, subject level analysis dataset, adverse event analysis dataset, basic data structure, adam other, study reference, occurrence data structure, integrated subject level, integrated basic data structure, integrated occurrence data structure or none subclass \[optional] recursive property for the class subsubclass within subclass is optional example json snippets { "class" { "classtype" "events" }, } { "class" { "classtype" "events", "subclass" { "subclass" "text" } }, } { "class" { "classtype" "events", "subclass" { "subclass" "text", "subsubclass" { "subclass" "text2" } } }, } { "class" { "classtype" "events", "subclass" { "subclass" "text", "subsubclass" { "subclass" "text2", "subsubclass" { "subclass" "text3" } } } }, } repeating \[optional] \[defaults to true] structure \[optional] purpose \[optional] referencedata \[optional] location \[optional] comment \[optional] variables \[optional] variables properties description aid the aid of an existing variable ordernumber should be unique in the list mandatory \[optional] specifies if the property is mandatory keysequence \[optional] role \[optional] method \[optional] the aid of an existing method hasnodata \[optional] \[boolean] indicates that an dataset has no records can be true or false nonstandard \[optional] \[boolean] indicates that an dataset has no records can be true or false indicates that this variable is not defined in the implementation guide standard referenced by the parent dataset variable { , "datatype" "integer", "length" 0, "fractiondigits" 0, "displayformat" "", "originrefs" \[ { "ordernumber" 0, "origintype" "collected", "source" "subject", "description" "", "documents" \[ { "aid" "01234567 89ab cdef 0123 456789abcdef", "ordernumber" 0, "pagerefs" \[ { "ordernumber" 0, "pagenumber" "", "pagerange" "", "title" "", "destination" \[ "", ] }, ] }, ] }, ], "comment" "01234567 89ab cdef 0123 456789abcdef", "terminology" "01234567 89ab cdef 0123 456789abcdef", "values" \[ "aid" "01234567 89ab cdef 0123 456789abcdef", "ordernumber" 0, "mandatory" true, "keysequence" 0, "role" "", "method" "01234567 89ab cdef 0123 456789abcdef", "selectioncriterias" \[ { "aid" "01234567 89ab cdef 0123 456789abcdef", "ordernumber" 0, "mandatory" true }, ], "hasnodata" "" ], "corecategory" "global" } request parameters description datatype must be text, integer, float, date, time, datetime, partialdate, partialtime, partialdatetime, durationdatetime, intervaldatetime, incompletedatetime length \[optional] fractiondigits \[optional] displayformat \[optional] originrefs \[optional] comment \[optional] the aid of an existing comment terminology \[optional] the aid of an existing terminology values \[optional] corecategory \[optional] string that indicates whether an adsl variable is a “core” variable free text, for example “global”, “safety”, “efficacy” originref properties description originrefs \[optional] ordernumber should be unique in the list origintype must be collected, derived, assigned, protocol, predecessor, not available source \[optional] must be subject, investigator, vendor, sponsor description \[optional] documents \[optional] document properties description aid the aid of an existing file ordernumber should be unique in the list mandatory \[optional] specifies if the property is mandatory keysequence \[optional] specifies if the property is mandatory role \[optional] method \[optional] the aid of an existing method selectioncriterias \[optional] hasnodata \[optional] \[boolean] indicates that the value has no data can be true or false selctioncriterias properties description aid the aid of an existing criteria ordernumber should be unique in the list mandatory \[optional] specifies if the property is mandatory value { "datatype" "float", "length" 0, "fractiondigits" 0, "displayformat" "", "originrefs" \[ { "ordernumber" 0, "origintype" "derived", "source" "vendor", "description" "", "documents" \[ { "aid" "01234567 89ab cdef 0123 456789abcdef", "ordernumber" 0, "pagerefs" \[ { "ordernumber" 0, "pagenumber" "", "pagerange" "", "title" "", "destination" \[ "", ] }, ] }, ] }, ], "comment" "01234567 89ab cdef 0123 456789abcdef", "terminology" "01234567 89ab cdef 0123 456789abcdef" } request parameters description datatype must be text, integer, float, date, time, datetime, partialdate, partialtime, partialdatetime, durationdatetime, intervaldatetime, incompletedatetime length \[optional] fractiondigits \[optional] displayformat \[optional] originrefs \[optional] comment \[optional] the aid of an existing comment terminology \[optional] the aid of an existing terminology originref properties description ordernumber should be unique in the list origintype must be collected, derived, assigned, protocol, predecessor, not available source \[optional] must be subject, investigator, vendor, sponsor description \[optional] documents \[optional] document properties description aid the aid of an existing file ordernumber should be unique in the list mandatory \[optional] specifies if the property is mandatory keysequence \[optional] method \[optional] the aid of an existing method pageref properties description pageref \[optional] ordernumber \[optional] must be unique in the list pagenumber \[optional] pagerange \[optional] title \[optional] destination \[optional] selection criteria { "criteria" \[ { "variable" "01234567 89ab cdef 0123 456789abcdef", "comparator" "gt", "values" \[ "", ], "terms" \[ { "aid" "01234567 89ab cdef 0123 456789abcdef", "ordernumber" 0, "rank" 0 0 }, ] }, ], "comment" "01234567 89ab cdef 0123 456789abcdef" } request parameters description criteria \[optional] comment \[optional] the aid of an existing comment criteria properties description variable \[optional] comparator \[optional] must be one of lt, le, gt, ge, eq, ne, in, notin values \[optional] terms \[optional] terms properties description aid the aid of an existing term ordernumber should be unique in the list rank \[optional] result display { "analysisresults" \[ { "aid" "01234567 89ab cdef 0123 456789abcdef", "ordernumber" 0 }, ], "documents" \[ { "aid" "01234567 89ab cdef 0123 456789abcdef", "ordernumber" 0, "pagerefs" \[ { "ordernumber" 0, "pagenumber" "", "pagerange" "", "title" "", "destination" \[ "", ] }, ] }, ] } request parameters description analysisresults \[optional] analysisresults properties description aid the aid of an existing term ordernumber should be unique in the list documents properties description aid the aid of an existing file ordernumber should be unique in the list pagerefs \[optional] pageref properties description pageref \[optional] ordernumber \[optional] must be unique in the list pagenumber \[optional] pagerange \[optional] title \[optional] destination \[optional] analysis result { "analysisreason" "", "analysispurpose" "", "parameter" "01234567 89ab cdef 0123 456789abcdef", "analysisdataset" { "comment" "01234567 89ab cdef 0123 456789abcdef", "datasets" \[ { "aid" "01234567 89ab cdef 0123 456789abcdef", "ordernumber" 0, "selectioncriteria" "01234567 89ab cdef 0123 456789abcdef", "variables" \[ { "aid" "01234567 89ab cdef 0123 456789abcdef", "ordernumber" 0, "mandatory" true, "keysequence" 0, "role" "", "method" "01234567 89ab cdef 0123 456789abcdef" }, ] }, ] }, "analysisdocumentation" { "description" \[ { "locale" "", "text" "" }, ], "documents" \[ { "aid" "01234567 89ab cdef 0123 456789abcdef", "ordernumber" 0, "pagerefs" \[ { "ordernumber" 0, "pagenumber" "", "pagerange" "", "title" "", "destination" \[ "", ] }, ] }, ] }, "analysiscode" { "context" "", "expression" "", "documents" \[ { "aid" "01234567 89ab cdef 0123 456789abcdef", "ordernumber" 0, "pagerefs" \[ { "ordernumber" 0, "pagenumber" "", "pagerange" "", "title" "", "destination" \[ "", ] }, ] }, ] } } request parameters description analysisreason \[optional] analysispurpose \[optional] parameter \[optional] the aid of an existing variable analysisdataset properties description comment \[optional] the aid of an existing comment datasets properties description aid the aid of an existing dataset ordernumber should be unique in the list selectioncriteria \[optional] variables properties description aid the aid of an existing variable ordernumber should be unique in the list mandatory \[optional] specifies if the property is mandatory keysequence \[optional] role \[optional] method \[optional] aid of an existing method analysisdocumentation properties description description \[optional] locale \[optional] text \[optional] documents \[optional] documents properties description aid the aid of an existing file ordernumber should be unique in the list pageref properties description pageref \[optional] ordernumber \[optional] must be unique in the list pagenumber \[optional] pagerange \[optional] title \[optional] destination \[optional] analysiscode properties description context \[optional] expression \[optional] description \[optional] documents \[optional] aid the aid of an existing file ordernumber should be unique in the list pageref \[optional] terminology when creating a terminology, terms and externaldictionary must not be sent in the same request example with { "datatype" "string", "comment" "01234567 89ab cdef 0123 456789abcdef", "terms" \[ { "aid" "01234567 89ab cdef 0123 456789abcdef", "ordernumber" 0, "rank" 0 0 } ] } example with { "datatype" "string", "externaldictionary" { "name" "", "version" "", "localereference" "", "externalreference" "" }, "comment" "01234567 89ab cdef 0123 456789abcdef" } request parameters description datatype must be text, integer, float, string comment \[optional] the aid of an existing comment externaldictionary \[optional] terms \[optional] ordernumber should be unique in the list rank \[optional] ' term { "code" "" "display" \[ { "locale" "", "text" "" }, ] } term assets ignore clinicalstage and therapeuticarea properties request parameters description display \[optional] comment { "comment" \[ { "locale" "", "text" "" }, ], "documents" \[ { "aid" "01234567 89ab cdef 0123 456789abcdef", "ordernumber" 0, "pagerefs" \[ { "ordernumber" 0, "pagenumber" "", "pagerange" "", "title" "", "destination" \[ "", ] }, ] }, ] } request parameters description comment \[optional] locale \[optional] text \[optional] documents properties description aid the aid of an existing file ordernumber should be unique in the list pageref properties description pageref \[optional] ordernumber \[optional] must be unique in the list pagenumber \[optional] pagerange \[optional] title \[optional] destination \[optional] file a previously uploaded file does not need to be referenced and a file asset can be created without a file in this case, ‘filereferences’ is sent as an empty list and ‘entrypoint’ is omitted { "filereferences" \[ { "uuid" "01234567 89ab cdef 0123 456789abcdef", "path" "" }, ], "entrypoint" { "uuid" "01234567 89ab cdef 0123 456789abcdef", "path" "" }, "source" "" } request parameters description filereferences properties description filereferences \[optional] uuid the uuid of an existing staged file path uuid and path are returned from 'add a temporary file' entrypoint properties description entrypoint \[optional] uuid the uuid of an existing staged file path uuid and path are returned from 'add a temporary file' uuid and path should be one of the entries from ‘filereferences’ source properties description source \[optional] a previously uploaded file does not need to be referenced and a file asset can be created without a file in this case, ‘filereferences’ is sent as an empty list and ‘entrypoint’ is omitted link { "urlprotocol" "", "urlbody" "" } request parameters description urlprotocol \[optional] urlbody \[optional] add an asset to an asset group put https //ryze formedix com/fws/api/repository/container/containeraid/containerversion/assetgroup/assetgroupaid/asset/assetaid this request can be used to add an existing asset to an asset group within a standard/study the containeraid and version specify the standard/study, the assetgroupaid specifies the asset group to add to and assetaid specifies the asset to add errors http status error code 400 invalid workflow state the container is not in an editable lifecycle state 400 invalid asset type the asset type is not valid for the asset group 400 invalid container aid an invalid administeredid was specified as the containeraid 400 invalid container version a non numeric value was specified as the version 400 invalid assetgroup aid an invalid administeredid was specified as the assetgroupaid 400 invalid asset aid an invalid administeredid was specified as the assetaid 404 unknown container unknown containeraid / version pair 404 unknown assetgroup unknown assetgroupaid within the containeraid / version pair 404 unknown asset unknown assetaid within the containeraid / version pair see also docid\ tqpncp50s5muu3bfnmk9w retrieve a list of libraries for a standard/study get https //ryze formedix com/fws/api/repository/container/containeraid/version/libraries this request returns a list of libraries for a standard/study in the system containeraid and version specify the standard/study containertype can be either standard or study category not in use, production, rejected, in review, in progress, draft example response \[ { "aid" "01234567 89ab cdef 0123 456789abcdef", "containertype" "standard", "version" 0, "versionlabel" "", "label" "", "name" "", "identifier" "", "status" "", "category" "not in use" }, ] errors http status error code 400 invalid container aid an invalid administeredid was specified as the containeraid 400 invalid container version a non numeric value was specified as the version 404 unknown container unknown containeraid / version pair see also docid\ tqpncp50s5muu3bfnmk9w associate a library with a standard/study request put https //ryze formedix com/fws/api/repository/container/containeraid/version/libraries/libraryaid/libraryversion this request can be used to associate a library with a standard/study containeraid and version specify the standard/study, and libraryaid and libraryversion specify the library example response { } errors http status error code 400 invalid container type a library cannot be added to a standard that has been published 400 invalid workflow state the library is not in a read only workflow state 400 cannot create already exists the specified library version is already associated with the container 400 invalid container aid an invalid administeredid was specified as the containeraid 400 invalid container version a non numeric value was specified as the version 400 invalid library aid an invalid administeredid was specified as the libraryaid 400 invalid library version a non numeric value was specified as the libraryversion 404 unknown container unknown containeraid / version pair, or libraryaid / libraryversion pair see also docid\ tqpncp50s5muu3bfnmk9w disassociate a library with a standard/study request delete https //ryze formedix com/fws/api/repository/container/containeraid/version/libraries/libraryaid/libraryversion this request can be used to disassociate a library with a standard/study containeraid and version specify the standard/study, and libraryaid and libraryversion specify the library example response { } errors http status error code 400 invalid container type a library cannot be added to a standard that has been published 400 invalid workflow state the library is not in a read only workflow state 400 invalid container aid an invalid administeredid was specified as the containeraid 400 invalid container version a non numeric value was specified as the version 400 invalid library aid an invalid administeredid was specified as the libraryaid 400 invalid library version a non numeric value was specified as the libraryversion 404 unknown container unknown containeraid / version pair, or libraryaid / libraryversion pair see also docid\ tqpncp50s5muu3bfnmk9w import assets from another asset group endpoint put https //ryze formedix com/fws/api/repository/container/containeraid/containerversion/library/import this request can be used to import assets from another standard/study the source standard/study must be associated as a library imported assets include any associated child assets containeraid and containerversion specify the target standard/study for the imported asset the source standard/study is specified in the request body example request { "sourcecontainer" "", "sourceversion" 0, "targetassetgroup" "", "assets" \[ "", ] } example response \[ { "sourceaid" "", "targetaid" "", }, ] parameters request parameters description sourcecontainer the aid of the standard/study to import assets from sourceversion the version number of the standard/study to import assets from targetassetgroup \[optional] is the aid of the asset group that the assets are to be imported to if not set, the asset is imported into the standard/study containeraid specified in the request assets lists any asset aids to be imported errors http status error code 400 invalid workflow state container is not editable 400 invalid container aid an invalid administeredid was specified as the containeraid 400 invalid container version a non numeric value was specified as the version 404 unknown container unknown containeraid / version pair 404 unknown source container unknown sourcecontainer aid/ sourceversion pair for source see also docid\ tqpncp50s5muu3bfnmk9w request the generation of an odm for an asset group this request can be used to generate and download the odm / define xml project file for an asset group you can use the containeraid , version , and assetgroupaid to specify which asset group is generated a unique identifier for the download is returned the unique identifier can then be used to request the download of the prepared file the returned uuid should be used in the file retrieval call as the fileuuid see replace containeraid , version , and assetgroupaid with your values request get https //ryze formedix com/fws/api/repository/container/containeraid/version/assetgroup/assetgroupaid/odm example response { "uuid" "01234567 89ab cdef 0123 456789abcdef" } errors http status error code 400 invalid assetgroup type asset groups of this type cannot have an odm generated 400 invalid container aid an invalid administeredid was specified as the containeraid 400 invalid container version a non numeric value was specified as the version 400 invalid assetgroup aid an invalid administeredid was specified as the assetgroupaid 404 unknown container unknown containeraid / version pair 404 unknown assetgroup could not find specified assetgroupaid for given containeraid / version pair see also docid\ tqpncp50s5muu3bfnmk9w upload the asset content of an odm/define into an asset group request put https //ryze formedix com/fws/api/repository/container/containeraid/version/assetgroup/assetgroupaid/odm request for the asset content of an odm / define xml project file to be uploaded to the asset group specified by the containeraid , version and assetgroupaid on success, an empty ok response is returned and the asset content of the file is added to the specified asset group for data acquisition asset groups, the expected file format is odm for dataset type asset groups, a define xml 2 0 file is expected example request multipartformdata containing a valid odm/define xml file, for example file “ /exampleodmfile xml” example response { } errors http status error code 400 invalid assetgroup type asset groups of this type cannot have an odm or define uploaded to them 400 invalid workflow state the container being uploaded to is in a non editable state 400 file not found multipartformdata does not include a file 400 invalid container aid an invalid aid was specified as the containeraid 400 invalid container version a non numeric value was specified as the version 400 invalid assetgroup aid an invalid administeredid was specified as the assetgroupaid 400 other indicates a problem with the file or the plugin environment see also docid\ tqpncp50s5muu3bfnmk9w create a new version of an existing container request put https //ryze formedix com/fws/api/repository/container/containeraid/version/version create a new version of the specified container based on the version specified on success, a json response is returned with the basic details of the new version of the container example response { "aid" "01234567 89ab cdef 0123 456789abcdef", "version" 0 } http status error code 400 invalid workflow state the container being versioned already has a version in an editable state 400 invalid container aid an invalid administeredid was specified as the containeraid 400 invalid container version a non numeric value was specified as the version 404 unknown container the container referred to by containeraid / version pair was not found 400 invalid container type this type of container cannot be versioned by users