Change Requests

retrieve a list of change request templates returns a list of change request templates including information about the states of the templates endpoint get https //ryze formedix com/fws/api/changerequest/template/listtemplates example response \[ { "uuid" “01234567 89ab cdef 0123 456789abcdef”, "name" "", "context" "standard", "active" true, "customproperties" \[ { "name" "", "propertytype" "text", "mandatory" true, "options" \[ "", ], "multiple" true, "ordernumber" 1 } ], "states" \[ { "uuid" "01234567 89ab cdef 0123 456789abcdef", "name" "", "approvallabels" \[ "", ], "category" "not started", "transitionsto" \[ { "uuid" "01234567 89ab cdef 0123 456789abcdef", "requiresapproval" true }, ] } ], "initialstate" "01234567 89ab cdef 0123 456789abcdef" }, ] response parameters possible values context none, standard, study, container, standard asset, study asset, asset category not started, completed, will not do, in review, in progress, draft propertytype text, note, number, datetime, select, url initialstate is an optional field that is returned if populated in the ryze ui options , multiple and ordernumber are optional fields in the customproperties and are returned depending on configuration in ryze errors see docid\ tqpncp50s5muu3bfnmk9w create a change request creates a new change request if the template id specified both exists and is active any container aids or asset aids specified are checked for existence before being created any specified custom properties are checked against the change request template endpoint post https //ryze formedix com/fws/api/changerequest request { "templateid" "01234567 89ab cdef 0123 456789abcdef", "title" "", "description" "", "duedate" "ccyymmddthhmmssz", "containeraids" \[ "01234567 89ab cdef 0123 456789abcdef", ], "assets" \[ { "containeraid" "01234567 89ab cdef 0123 456789abcdef", "assetaid" "01234567 89ab cdef 0123 456789abcdef" }, ], "customproperties" \[ { "name" "", "values" \["", ], "propertytype" "text", "mandatory" true, "ordernumber" 1 }, ] } request parameters values duedate \[optional] containers \[optional] assets \[optional] customproperties \[optional] duedate \[optional] assetaid \[optional] ‘propertytype’ text, note, number, datetime, select, url the context set on the change request template (none, standard, study, container, standard asset, study asset, asset) impacts which properties should be sent when creating the change request if request includes properties that are not permitted within the context, an invalid context details error is returned the change request template is configured in ryze, admin > repository > change requests if the context is none, then it is expected that there will be no assets or containers specified in the request if the context is container and the user has chosen to supply containeraids, then there must be no assets specified if the context is set to standard or study, then those containers must be of that container type if the context is assets and the user chooses to supply assets, then both the assets field and the containeraids fields must be populated the containeraids and the containeraid fields in the assets field must match if the context is set to standard asset or study asset, then the assets specified in the request must be from one of those container types example response { "id" "cr 0" } related requests errors http status error code 400 invalid template id badly formatted templateid 404 unknown template template not found for templateid 400 template inactive template not activated 400 change request custom properties invalid invalid custom properties for template 400 invalid container aid badly formatted container aid 404 unknown container container not found for aid 400 invalid asset aid badly formatted asset aid 400 invalid context details incorrect container or asset details for template context 404 unknown asset asset not found for aid see also docid\ tqpncp50s5muu3bfnmk9w retrieve change request details retrieve the details of a change request with the specified id endpoint get https //ryze formedix com/fws/api/changerequest/\ id response { "id" "cr 1", "title" "", "description" "", "created" “ccyymmddthhmmssz”, "duedate" “ccyymmddthhmmssz”, "customproperties" \[ { "name" "", "values" \["", ], "propertytype" "text", "mandatory" true, "ordernumber" 1 }, ], "updated" “ccyymmddthhmmssz”, "templateid" "01234567 89ab cdef 0123 456789abcdef", "templatename" "", "templatecontext" "standard", "stateid" "01234567 89ab cdef 0123 456789abcdef", "statename" "", "statecategory" "not started", "approvers" \[ { "label" "", "username" "", "isapproved" true }, ], "owner" "", "assignee" "", "containers" \[ { "aid" "01234567 89ab cdef 0123 456789abcdef", "label" "", "version" 1, "containertype" "standard" }, ], "assets" \[ { "container" { "aid" "01234567 89ab cdef 0123 456789abcdef", "label" "", "version" 1, "containertype" "standard" }, "asset" { "aid" "01234567 89ab cdef 0123 456789abcdef", "assettype" "form", "label" "" } }, ], "completedversions" \[ { "container" { "aid" "01234567 89ab cdef 0123 456789abcdef", "label" "", "version" 1,mand "containertype" "standard" }, "asset" { "aid" "01234567 89ab cdef 0123 456789abcdef", "assettype" "form", "label" "" } }, ], "comments" \[ { "uuid" "01234567 89ab cdef 0123 456789abcdef", "username" "", "at" “ccyymmddthhmmssz”, "comment" "" }, ], “filereferences” \[ { “uuid” “01234567 89ab cdef 0123 456789abcdef”, “path” “” }, … ] } request parameters accepted values propertytype text, note, number, datetime, select, url templatecontext none, standard, study, container, standard asset, study asset, asset statecategory not started, completed, will not do, in review, in progress, draft containertype standard, study assettype visit schedule, visit, form, section, question, condition, method, unit, dataset, variable, value, selection criteria, result display, analysis result, terminology, term, comment, file, link duedate \[optional] updated \[optional] templateid \[optional] templatename \[optional] templatecontext \[optional] stateid \[optional] statename \[optional] statecategory \[optional] assignee \[optional] customproperties > mandatory \[optional] assets > asset \[optional] completedversions > asset \[optional] comments > username \[optional] when creating a change request and sending container information, only a container aid is specified when retrieving a change request, thet container information received contains the aid and the latest version for that container errors http status error code 404 unknown change request change request not found for specified id 404 change request deleted change request is in a deleted state see also docid\ tqpncp50s5muu3bfnmk9w add approver to change request state transition request put https //ryze formedix com/fws/api/changerequest/\ crid/approver/\ crsuuid/\ label/\ useruuid request parameters accepted values crid change request id crsuuid change request state id label label of change request state for user to be added as useruuid uuid of the user being added add a user with the specified uuid as a change request state transition approver for the specified label response {} related requests https //docs formedix com/api/users#iknoh errors http status error code 404 unknown change request change request not found for crid 404 change request deleted change request has been deleted 400 invalid change request state uuid change request state crsuuid invalid format 404 unknown change request state change request state not found for crsuuid 400 invalid approval label invalid label for specified change request state transition 400 invalid user id invalid format for useruuid 404 unknown user user not found for given useruuid see also docid\ tqpncp50s5muu3bfnmk9w remove approver from change request state transition remove a user with the specified uuid from a change request state transition for the specified label request delete https //ryze formedix com/fws/api/changerequest/\ crid/approver/\ crsuuid/\ label/\ useruuid r equest parameters accepted values crid change request id crsuuid change request state id label label of change request state for user to be added as useruuid uuid of the user being added response {} related requests https //docs formedix com/api/users#iknoh errors http status error code 404 unknown change request change request not found for crid 404 change request deleted change request has been deleted 400 invalid change request state uuid change request state crsuuid invalid format 404 unknown change request state change request state not found for crsuuid 400 invalid approval label invalid label for specified change request state transition 400 invalid user id invalid format for the useruuid 404 unknown user user not found for the specified useruuid 404 approver not assigned user doesn’t exist on change request as an approver 400 change request already approved trying to remove a user that has already approved change request transition see also docid\ tqpncp50s5muu3bfnmk9w delete a change request delete a change request with the specified id request delete https //ryze formedix com/fws/api/changerequest/\ crid response {} related requests https //docs formedix com/api/change requests#muj6b errors http status error code 404 unknown change request change request not found for id see also docid\ tqpncp50s5muu3bfnmk9w transition change request state transitions the change request to the change request state with the specified state uuid will validate that both the change request and the change request state for the specified ids exist before transitioning request put https //ryze formedix com/fws/api/changerequest/\ crid/transition/\ crsuuid response {} errors http status error code 404 unknown change request change request not found for crid 400 invalid change request state uuid change request state crsuuid invalid format 404 change request deleted change request has been deleted 404 unknown change request state change request state not found for crsuuid see also docid\ tqpncp50s5muu3bfnmk9w approve a change request state transition transitions the change request to the change request state with the specified state uuid will validate that both the change request and the change request state for the specified ids exist before transitioning request put https //ryze formedix com/fws/api/changerequest/\ crid/approve/\ label/\ userid response {} related requests https //docs formedix com/api/users#iknoh errors http status error code 404 unknown change request change request not found for specified crid 400 invalid user id userid is invalid format 404 change request deleted change request has been deleted 404 unknown user user not found for specified userid 400 invalid user user is either not enabled or awaiting activation 400 invalid approval label invalid label for specified change request transition 400 approver not assigned user trying to be approved is not assigned see also docid\ tqpncp50s5muu3bfnmk9w associate an uploaded file to a change request endpoint put https //ryze formedix com/fws/api/changerequest/\ crid/file allows the user to associate a previously uploaded file (add a temporary file) to the change request with the supplied crid the uuid and path supplied in the request will be the same values as the ‘add a temporary file’ call request { "uuid" "01234567 89ab cdef 0123 456789abcdef", "path" "" } response { "uuid" "01234567 89ab cdef 0123 456789abcdef", "path" "" } related requests https //docs formedix com/api/general#9mywv errors http status error code 400 invalid file id format the id passed in the request isn’t a valid uuid 404 unknown change request change request not found for specified id 404 unknown file can’t find previously uploaded file 404 change request deleted change request has been deleted see also docid\ tqpncp50s5muu3bfnmk9w request a change request files download allows the user to request the preparation of files associated with a change request for download where crid is the change request and fileid is the file associated with that change request endpoint get https //ryze formedix com/fws/api/changerequest/\ crid/file/\ fileid response { "uuid" "01234567 89ab cdef 0123 456789abcdef" } related requests https //docs formedix com/api/general#w vmw errors http status error code 404 unknown change request change request not found for specified crid 400 invalid file id fileid not correct format 404 unknown file file not found for fileid specified 404 change request deleted change request has been deleted see also docid\ tqpncp50s5muu3bfnmk9w update a change request allows a user to update a change request with the specified id endpoint put https //ryze formedix com/fws/api/changerequest/\ crid request { "title" "", "description" "", "duedate" "ccyymmddthhmmssz", "containeraids" \[ "", ], "assets" \[ { "containeraid" "", "assetaid" "" }, ], "customproperties" \[ { "name" "", "values" \["", ], "propertytype" "number", "mandatory" true, "ordernumber" 1 }, ], "completedversions" \[ { "container" { "aid" "", "version" 1 }, "asset" { "aid" "" } }, ] } request parameters accepted values propertytype text, note, number, datetime, select, url assets \[optional] customproperties \[optional] completedversions \[optional] if title , description or duedate are omitted, their previous value is retained if assets are supplied, then they must specify a containeraid but an assetaid is optional if completedversions are supplied, then a container must be specified but the asset is optional response { } errors http status error code 404 unknown change request change request not found for id 404 unknown template template not found for change request 400 invalid context details incorrect details specified for change request template 400 change request custom properties invalid custom properties are invalid for template 400 invalid container aid container aid wrong format 404 unknown container container not found for aid 400 invalid asset aid asset aid wrong format 404 unknown asset asset not found for aid 404 change request deleted change request has been deleted see also docid\ tqpncp50s5muu3bfnmk9w