diff --git a/dev-manual/api/_code/hide_request_ingest.curl b/dev-manual/api/_code/hide_request_ingest.curl new file mode 100644 index 00000000..466fbe4c --- /dev/null +++ b/dev-manual/api/_code/hide_request_ingest.curl @@ -0,0 +1,4 @@ +curl -X DELETE \ + http://my_archivematica_instance.archivematica.org/api/ingest/ \ + 89fd478d-c896-461a-baec-5d1faf661020/delete/ \ + -H 'Authorization: ApiKey [_your_username_]:[_your_ApiKey_]' diff --git a/dev-manual/api/_code/hide_request.curl b/dev-manual/api/_code/hide_request_transfer.curl similarity index 55% rename from dev-manual/api/_code/hide_request.curl rename to dev-manual/api/_code/hide_request_transfer.curl index 0e581865..3a8d59b7 100644 --- a/dev-manual/api/_code/hide_request.curl +++ b/dev-manual/api/_code/hide_request_transfer.curl @@ -1,5 +1,4 @@ curl -X DELETE \ - http://my_archivematica_instance.archivematica.org/api/transfer/status/ - 89fd478d-c896-461a-baec-5d1faf661020/ \ - -H 'Authorization: ApiKey [_your_username_]:[_your_ApiKey_]' \ - -H 'Host: my_archivematica_instance.archivematica.org' + http://my_archivematica_instance.archivematica.org/api/transfer/ + 89fd478d-c896-461a-baec-5d1faf661020/delete/ \ + -H 'Authorization: ApiKey [_your_username_]:[_your_ApiKey_]' diff --git a/dev-manual/api/api-reference-archivematica.rst b/dev-manual/api/api-reference-archivematica.rst index fe3557eb..c767fa60 100644 --- a/dev-manual/api/api-reference-archivematica.rst +++ b/dev-manual/api/api-reference-archivematica.rst @@ -224,15 +224,26 @@ Hide delete/** =========== ================================= ============================== +Request body parameters: + +================= ===================== +``transfer_uuid`` UUID of the transfer. +================= ===================== + +Response definitions: + +=========== ====================== +``removed`` Boolean true or false. +=========== ====================== + Example request: -.. literalinclude:: _code/hide_request.curl +.. literalinclude:: _code/hide_request_transfer.curl Example response: .. literalinclude:: _code/hide_response.curl - Completed ^^^^^^^^^ @@ -352,15 +363,25 @@ Hide ``DELETE`` **/api/ingest//delete/** *Hides a SIP.* =========== =================================== ============================== +Request body parameters: +============= ================ +``sip_uuid`` UUID of the SIP. +============= ================ + +Response definitions: + +=========== ====================== +``removed`` Boolean true or false. +=========== ====================== + Example request: -.. literalinclude:: _code/hide_request.curl +.. literalinclude:: _code/hide_request_ingest.curl Example response: .. literalinclude:: _code/hide_response.curl - List SIPS Waiting for User Input ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^