Work.upload.begin: Difference between revisions

From Safe Creative API
Jump to navigation Jump to search
w>Jguillo
(Created page with 'Initiates an upload process. This component must be called through an upload API server returned by work.upload.lookup Once this method has been called you can call [[work.u…')
 
m (6 revisions imported)
 
(5 intermediate revisions by one other user not shown)
Line 8: Line 8:
* '''Timestamp:''' Requires [[ztime parameter]]
* '''Timestamp:''' Requires [[ztime parameter]]
* '''Authorization level:''' ADD
* '''Authorization level:''' ADD
* '''API trust level''': Standard
* '''API server''': Upload server returned by [[work.upload.lookup]]


= Parameters =  
= Parameters =  
* '''authkey*:''' Authorization key of the work owner
* '''authkey*:''' Authorization key
* '''ztime*:''' Z-Timestamp
* '''ztime*:''' Z-Timestamp
* '''uploadid*:''' Upload ID obtained from [[work.upload.lookup]]
* '''uploadid*:''' Upload ID obtained from [[work.upload.lookup]]
Line 17: Line 19:


= Returns =
= Returns =
* restvalueresponse
* '''restvalueresponse'''
** state: ready
** '''state''': ready


= Sample =
= Example =
REQUEST:
REQUEST:



Latest revision as of 08:07, 7 May 2021

Initiates an upload process. This component must be called through an upload API server returned by work.upload.lookup

Once this method has been called you can call work.upload.chunk to upload the work contents.

Info

  • Component name: work.upload.begin
  • Signature: Requires signature using the authkey's private key
  • Timestamp: Requires ztime parameter
  • Authorization level: ADD
  • API trust level: Standard
  • API server: Upload server returned by work.upload.lookup

Parameters

  • authkey*: Authorization key
  • ztime*: Z-Timestamp
  • uploadid*: Upload ID obtained from work.upload.lookup

* Required parameter

Returns

  • restvalueresponse
    • state: ready

Example

REQUEST:

https://upload01.safecreative.org/v2/
?component=work.upload.begin
&authkey=1i5g2aaf2bz09lyo867cuimqg
&uploadid=3c33a96c-7743-43d0-9614-db70fa46d3ad
&ztime=1271749837035
&signature=668eea80a7f6654a7ec65a74583bbacbc2edc6b5

RESPONSE:

<?xml version="1.0" encoding="UTF-8"?>
<restvalueresponse>
  <state>ready</state>
</restvalueresponse>