Edit details of multiple files

This call edits the details for multiple specified files. Use this call to modify the existing information for the files or add new information while preserving omitted parameters. For each of the specified files, the call edits its name, tags, and metadata.

For each of the specified files, the call sets a new name, new tags, and metadata. The maximum number of files you can edit the details for per call is 100.

Request

https://cgc-api.sbgenomics.com/v2/bulk/files/edit

Example request

POST v2/bulk/files/edit
Host: cgc-api.sbgenomics.com
X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74

curl -X POST \
  https://cgc-api.sbgenomics.com/v2/bulk/files/update \
  -H 'Cache-Control: no-cache' \
  -H 'Content-Type: application/json' \
  -H 'X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74' \
  -d '{
    "items": [
        {
            "file_id": "568e69abe9b0307bc0412345",
                "name": "api_test2",
                "tags": ["test9"],
                "metadata": {
                    "sample_id": "sample1"
                }
        },
        {
            "file_id": "568e69abe9b0307bc0498765",
                "metadata": {
                    "sample_id": "sample1"
                }
        },
        {
            "file_id": "593e69abe9b0307bc0498765",
                "tags": ["test3"]
        },
        {
            "file_id": "593e69abe9b0307bc0412345"
        }
    ]
}'

Header Fields

Name	Description
X-SBG-Auth-Token required	Your CGC authentication token.
Content-Type required	`application/json`

Request body

Key	Data type	Description
`file_id`	string	The IDs of the file you are editing. The maximum number of files you can edit the details for per call is 100.
`name`	string	The new name of the file.
`tags`	array	The tags you want to edit.
`metadata`	dictionary of key-value pairs	The metadata fields and their values that you want to edit.

Response

See a list of CGC-specific response codes that may be contained in the body of the response..

Response body

The response contains information the updated information for all of the edited files.

Example response body

{
    "items": [
        {
            "resource": {
                "href": "https://cgc-api.sbgenomics.com/v2/files/568e69abe9b0307bc0412345",
                "id": "568e69abe9b0307bc0412345",
                "name": "1000G_phase1.snps.high_confidence.b37.vcf",
                "size": 7313069069,
                "project": "rfranklin/my-project",
                "created_on": "2018-03-01T10:22:44Z",
                "modified_on": "2018-03-01T10:22:44Z",
                "storage": {
                    "type": "PLATFORM"
                },
                "origin": {},
                "tags": [],
                "metadata": {}
            }
        },
        {
            "resource": {
                "href": "https://cgc-api.sbgenomics.com/v2/files/568e69abe9b0307bc0498765",
                "id": "568e69abe9b0307bc0498765",
                "name": "C835.HCC1143_BL.4.contig_1_mpileup_SNPs.filtered.Somatic.hc.and_more.concat.sorted.reordered.vcf",
                "size": 5313069069,
                "project": "rfranklin/my-project",
                "created_on": "2018-03-01T10:22:44Z",
                "modified_on": "2018-03-01T10:22:44Z",
                "storage": {
                    "type": "PLATFORM"
                },
                "origin": {},
                "tags": [],
                "metadata": {}
            }
        }
        }
    ]
}