General

add a temporary file endpoint post https //ryze formedix com/fws/api/file multipart post, for example content type multipart/form data; boundary= xxx authorization bearer 12345d c123 1ce0 9893 0123456c83b \ xxx content disposition form data; name="file"; filename=" /odm fdx" (data) \ xxx content disposition form data; name="json" {"requestid" "example123"} \ xxx this request can be used to add a temporary file to the system the temporary file can be used in any further calls which reference a file for example, a file can be uploaded using this call, and then a file asset can be created that references it this request is sent as a https //www w3 org/tr/html401/interact/forms html#h 17 13 4 2 post request with the first part json and the second part being the file to stage if a file is staged successfully, the response will include the original requestid and the file reference example response { "requestid" "1234567890", "uuid" "2f4f2f22 6860 4312 aa5f fb3ea6c595f9", "path" "stagedfile xml" } errors http status error code 400 malformed json the input json request is missing 400 file not found the input file is missing from the request see also docid\ tqpncp50s5muu3bfnmk9w retrieve a previously prepared file endpoint get https //ryze formedix com/fws/api/file/fileuuid replace fileuuid with the value from the previous request retrieve the previously prepared file specified by the fileuuid as a standard binary octet stream should the file not yet be available, or no longer exist in the system, an appropriate http response is returned the fileuuid is the uuid previously returned to the caller on a file generation request files are removed from the system 7 days after their generation and the related uuid will no longer be valid if a file is required after this period, the initial ‘request’ to generate the file can be re performed (and a new uuid assigned) the generated file must be saved as a zip file response octet stream of the file errors http status error code 400 invalid uuid an invalid uuid was specified as the fileuuid 404 unknown file the fileuuid specified does not match any known generated files see also docid\ tqpncp50s5muu3bfnmk9w retrieve checksums for a previously prepared file endpoint get https //ryze formedix com/fws/api/file/fileuuid/checksum retrieve checksums for the previously prepared file as specified by the given fileuuid if the file is not yet available or no longer exists in the system, an appropriate http response is returned the fileuuid is the uuid previously returned to the caller on a file generation request currently, only the md5 hash of the file is returned example response { "md5" "0123456789abcdef0123456789abcdef" } errors http status error code 400 invalid uuid an invalid uuid was specified as the fileuuid 404 unknown file the fileuuid specified does not match any known generated files 404 file checksum not found a file was found but it had no checksum stored see also docid\ tqpncp50s5muu3bfnmk9w request a file asset’s files endpoint get https //ryze formedix com/fws/api/repository/container/containeraid/containerversion/asset/assetaid/files retrieve the files associated with a file asset for the specified assetaid in containeraid and containerversion this request returns a uuid that can be used with the existing retrieve a previously prepared file request example response { "uuid" "01234567 89ab cdef 0123 456789abcdef" } 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 asset aid an invalid administeredid was specified as the assetaid 400 invalid asset type if the supplied assetaid isn’t a file asset 404 unknown container unknown containeraid / version pair 404 unknown asset unknown asset within the containeraid / version pair see also docid\ tqpncp50s5muu3bfnmk9w