Resource Collection

Get Resource Collection

GET http://localhost/api_v1/targets/:target_name:/resources/

This endpoint allows you to get all resources for a given Target and Token

Path Parameters

Name	Type	Description
target_name	string	Name of the Target

Headers

Name	Type	Description
presqt-source-token	string	User's Target Token

200 Target Resources successfully retrieved.

[
        {
            "kind": "container",
            "kind_name": "folder",
            "id": "a02d7b96-a4a9-4521-9913-e3cc68f4d9dc",
            "container": "None",
            "title": "Folder_Name",
            "detail": "http://localhost/api_v1/targets/osf/resources/a02d7b96-a4a9-4521-9913-e3cc68f4d9dc"
        },
        {
            "kind": "item",
            "kind_name": "file",
            "id": "5b305f1b-0da6-4a1a-9861-3bb159d94c96",
            "container": "a02d7b96-a4a9-4521-9913-e3cc68f4d9dc",
            "title": "file.jpg",
            "detail": "http://localhost/api_v1/targets/osf/resources/5b305f1b-0da6-4a1a-9861-3bb159d94c96"
        },...
    ]

400 The target provided does not support the action requested or 'presqt-source-token' missing in the request header

{
    "error": "'new_target' does not support the action 'resource_collection'."
}
or
{
    "error": "'presqt-source-token' missing in the request headers."
}

401 The provided token is invalid

{
    "error": "Token is invalid. Response returned a 401 status code.""
}

404 Could not find a matching Target

{
    "error": "'bad_target' is not a valid Target name."
}

Upload Top Level Resource

POST http://localhost/api_v1/targets/:target_name:/resources/

This endpoint allows you to upload a top level resource. For instance, a new project.

Path Parameters

Name	Type	Description
target_name	string	Name of the Target

Headers

Name	Type	Description
duplicate-file-action	string	Flag for handling file duplication. Must be either 'ignore' or 'update'
presqt-destination-token	string	User's token for the destination target

Request Body

Name	Type	Description
presqt-file	object	Zip file of the resources to upload

202 Resource upload has successfully started

{
    "ticket_number": "some_uuid"
    "message": "The server is processing the request."
}

400 The target provided does not support the requested action or 'presqt-destination-token' missing in the request headers or 'presqt-file' not found in the body or The file provided is not a zip file or The file provided is not in BagIt format or Checksums in the bag did not validate or 'presqt-file-duplicate-action' missing in the request headers or An invalid duplicate action was provided or The project provided was not formatted correctly. Either multiple top level folders present or files are at the top level

{
    "error": "'new_target' does not support the action 'resource_upload'."
}
or
{
    "error": "'presqt-destination-token' missing in the request headers."
}
or
{
    "error": "The file, 'presqt-file', is not found in the body of the request."
}
or
{
    "error": "The file provided, 'presqt-file', is not a zip file."
}
or
{
    "error": "The file provided is not in BagIt format."
}
or
{
    "error": "Checksums failed to validate."
}
or
{
    "error": "'presqt-file-duplicate-action' missing in the request headers."
}
or
{
    "error": "'bad_action' is not a valid file_duplicate_action.
    The options are 'ignore' or 'update'."
}
or
{
    "error": "Project is not formatted correctly. Multiple directories
    exist at the top level."
}
or
{
    "error": "Project is not formatted correctly. Files exist at the top level."
}

401 The provided token is invalid

{
    "error": "Token is invalid. Response returned a 401 status code."
}

404 Could not find a matching target

{
    "error": "'bad_name' is not a valid Target name."
}