Existing Datasets

List Existing Datasets

Use the GET:List Datasets endpoint to return a list of datasets already present in your tenant

The response includes the datasetId which is required to interact with the dataset via other endpoints

Sample Response

[
    {
        "isPermissionedView": false,
        "datasetId": "0B533DE6-7107-9FCD-48FC-31C0856745CC",
        "name": "WFP Position Dataset",
        "type": "POSITIONS",
        "_links": {
            "dataset:retrieve": {
                "url": "https://orgvue-qa.eu-west-1.concentra.io/api/v1/DIGITAL_LEARNING/datasets/0B533DE6-7107-9FCD-48FC-31C0856745CC",
                "method": "GET",
                "type": "application/json; charset=UTF-8"
            },
            "dataset:export": {
                "url": "https://orgvue-qa.eu-west-1.concentra.io/api/v1/DIGITAL_LEARNING/datasets/0B533DE6-7107-9FCD-48FC-31C0856745CC/export",
                "method": "POST",
                "type": "application/json; charset=UTF-8"
            }
        }
    },
    {
        "isPermissionedView": false,
        "datasetId": "DBB610F8-043E-2B52-7262-B397C934F326",
        "name": "OV3 Demo Dataset 2",
        "type": "PEOPLE",
        "_links": {
            "dataset:retrieve": {
                "url": "https://orgvue-qa.eu-west-1.concentra.io/api/v1/DIGITAL_LEARNING/datasets/DBB610F8-043E-2B52-7262-B397C934F326",
                "method": "GET",
                "type": "application/json; charset=UTF-8"
            },
            "dataset:export": {
                "url": "https://orgvue-qa.eu-west-1.concentra.io/api/v1/DIGITAL_LEARNING/datasets/DBB610F8-043E-2B52-7262-B397C934F326/export",
                "method": "POST",
                "type": "application/json; charset=UTF-8"
            }
        }
    },
    {
        "isPermissionedView": false,
        "datasetId": "05E3BA02-2CE7-B4D6-7D60-67D2EC793D61",
        "name": "Links from Ov3 Demo Dataset 3 to OrgVue 3 Demo Positions Dataset",
        "type": "LINKS",
        "_links": {
            "dataset:retrieve": {
                "url": "https://orgvue-qa.eu-west-1.concentra.io/api/v1/DIGITAL_LEARNING/datasets/05E3BA02-2CE7-B4D6-7D60-67D2EC793D61",
                "method": "GET",
                "type": "application/json; charset=UTF-8"
            },
            "dataset:export": {
                "url": "https://orgvue-qa.eu-west-1.concentra.io/api/v1/DIGITAL_LEARNING/datasets/05E3BA02-2CE7-B4D6-7D60-67D2EC793D61/export",
                "method": "POST",
                "type": "application/json; charset=UTF-8"
            }
        }
    }
]

Dataset Metadata

To export details of an existing dataset use the GET:Dataset Metadata endpoint inserting the required datasetId to the GET request

e.g. https://{baseUrl}/api/v1/{tenantId}/datasets/{datasetId}

The response includes the dataset metadata also available via Orgvue Settings along with the property metadata and details of any Drafts created from the dataset

Sample response

{
    "datasetId": "DA08093D-B517-F6FB-32F2-076B7050D607",
    "cacheKey": "aa+cRiBc6pht7xW6sQczOuPkqDJpcWw9uwY/uAGa6MOKYUd8D6x3jqL2jb6Zs1Mzykj04+rxipegFTn1AbEZAg==",
    "createdBy": "userguide@orgvue.com",
    "modifiedBy": "userguide@orgvue.com",
    "modifiedAt": "2023-05-25T08:49:32.862Z",
    "name": "User Guide Dataset",
    "type": "PEOPLE",
    "autoId": "Employee ID",
    "treeId": "Employee ID",
    "treeParentId": "Manager ID",
    "labelId": "Full Name",
    "tags": ["example-tag"],
    "items": {
        "lastTransactionId": "00000186-73A7-DCDC-B097-53C3BE2DA70E",
        "modifiedAt": "2023-02-21T11:07:06.332Z"
    },
    "properties": [
        {
            "key": "Position Title",
            "name": "Position Title",
            "type": "text",
            "sortOrder": 0
        },
        {
            "key": "FTE",
            "name": "FTE",
            "type": "number",
            "sortOrder": 12
        },
        {
            "key": "Full Name",
            "name": "Full Name",
            "type": "text",
            "isLabelId": true,
            "isCore": true,
            "isRequired": true,
            "sortOrder": 13
        },
        {
            "key": "Employee ID",
            "name": "Employee ID",
            "type": "number",
            "isAutoId": true,
            "isTreeId": true,
            "isCore": true,
            "sortOrder": 21
        },
        {
            "key": "Location",
            "name": "Location",
            "type": "text",
            "sortOrder": 22
        },
        {
            "key": "Manager ID",
            "name": "Manager ID",
            "type": "number",
            "isTreeParentId": true,
            "isCore": true,
            "isRequired": true,
            "sortOrder": 23
        },
    ],
    "_links": {
        "self": {
            "url": "https://orgvue-qa.eu-west-1.concentra.io/api/v1/DIGITAL_LEARNING/datasets/DA08093D-B517-F6FB-32F2-076B7050D607",
            "method": "GET",
            "type": "application/json; charset=UTF-8"
        },
        "dataset:export:jsonRows": {
            "url": "https://orgvue-qa.eu-west-1.concentra.io/api/v1/DIGITAL_LEARNING/datasets/DA08093D-B517-F6FB-32F2-076B7050D607/export/jsonRows",
            "method": "POST",
            "type": "application/json; charset=UTF-8"
        },
        "dataset:export:jsonColumns": {
            "url": "https://orgvue-qa.eu-west-1.concentra.io/api/v1/DIGITAL_LEARNING/datasets/DA08093D-B517-F6FB-32F2-076B7050D607/export/jsonColumns",
            "method": "POST",
            "type": "application/json; charset=UTF-8"
        },
        "dataset:export:csv": {
            "url": "https://orgvue-qa.eu-west-1.concentra.io/api/v1/DIGITAL_LEARNING/datasets/DA08093D-B517-F6FB-32F2-076B7050D607/export/csv",
            "method": "POST",
            "type": "application/json; charset=UTF-8"
        },
        "dataset:export:tsv": {
            "url": "https://orgvue-qa.eu-west-1.concentra.io/api/v1/DIGITAL_LEARNING/datasets/DA08093D-B517-F6FB-32F2-076B7050D607/export/tsv",
            "method": "POST",
            "type": "application/json; charset=UTF-8"
        }
    },
    "drafts": [
        {
            "draftId": "EBD8EE06-CD49-68F3-3176-E09F5A78D2CC",
            "name": "API draft test ",
            "_links": {
                "draft:retrieve": {
                    "url": "https://orgvue-qa.eu-west-1.concentra.io/api/v1/DIGITAL_LEARNING/drafts/EBD8EE06-CD49-68F3-3176-E09F5A78D2CC",
                    "method": "GET",
                    "type": "application/json; charset=UTF-8"
                }
            }
        },
    ]
}