Data Owner APIs

Get Data Owner Configuration (GET)

Returns data owner configuration settings.

Route

URI	/api/v1/Workflow/Dataowner/Config
Method	GET
Result	JSON – DataOwnerConfigModel

Parameters

None

Example

GET http://localhost/api/v1/Workflow/Dataowner/Config
{
    "$type": "pn.openService.dataOwner.ResourceOwnerConfigurationModel, pn.openService.interfaces",
    "entriesByResource": {
        "$type": "System.Collections.Generic.Dictionary`2[[System.String, mscorlib],[pn.openService.dataOwner.ResourceOwnerConfigurationEntryModel, pn.openService.interfaces]], mscorlib"
    },
    "resourceNodes": {
        "$type": "System.Collections.Generic.Dictionary`2[[System.String, mscorlib],[pn.openService.dataOwner.ResourceOwnerConfigurationResourceModel, pn.openService.interfaces]], mscorlib"
    },
    "entriesByTechnology": {
        "$type": "System.Collections.Generic.Dictionary`2[[pn.fasels.aidMan.ResourceType, libInterfaces],[pn.openService.dataOwner.ResourceOwnerConfigurationEntryModel, pn.openService.interfaces]], mscorlib"
    },
    "technologyNodes": {
        "$type": "System.Collections.Generic.Dictionary`2[[pn.fasels.aidMan.ResourceType, libInterfaces],[pn.openService.models.ResourceTypeModel, pn.openService.interfaces]], mscorlib"
    },
    "rootEntry": null
}

Check If Data Owner Is Enabled (GET)

Checks if data owner functionality is enabled.

Route

URI	/api/v1/Workflow/Dataowner/IsEnabled
Method	GET
Result	JSON – bool

Parameters

None

Example

GET http://localhost/api/v1/Workflow/Dataowner/IsEnabled
{
    False
}

Get Data Owner Children (GET)

Returns child nodes for a data owner resource.

Route

URI	/api/v1/Workflow/Dataowner/Children
Method	GET
Result	JSON – Array of DataOwnerNodeModel

Parameters

Query parameters for parent node identification.

Example

GET http://localhost/api/v1/Workflow/Dataowner/Children

Get Data Owner Ancestors (GET)

Returns ancestor nodes for a data owner resource.

Route

URI	/api/v1/Workflow/Dataowner/Ancestors
Method	GET
Result	JSON – Array of DataOwnerNodeModel

Parameters

Query parameters for node identification.

Example

GET http://localhost/api/v1/Workflow/Dataowner/Ancestors

Get Data Owner Roots (GET)

Returns root nodes for data owner by type.

Route

URI	/api/v1/Workflow/Dataowner/Roots/{type}
Method	GET
Result	JSON – Array of DataOwnerNodeModel

Parameters

The type identifier.

Example

GET http://localhost/api/v1/Workflow/Dataowner/Roots/1
[
    {
        "$type": "pn.openService.dataOwner.ResourceOwnerConfigurationResourceModel, pn.openService.interfaces",
        "resource": {
            "$type": "pn.openService.models.LightResourceModel, pn.openService.interfaces",
            "uriKey": "",
            "displayName": "exchangetest100.local",
            "displayPath": "",
            "resourceType": 1,
            "typeId": 15100
        },
        "hasChildren": true,
        "hasConfigurationEntry": false,
        "descendantHasConfigurationEntry": false
    },
    {
        "$type": "pn.openService.dataOwner.ResourceOwnerConfigurationResourceModel, pn.openService.interfaces",
        "resource": {
            "$type": "pn.openService.models.LightResourceModel, pn.openService.interfaces",
            "uriKey": "",
            "displayName": "lab.protected-networks.local",
            "displayPath": "",
            "resourceType": 1,
            "typeId": 15100
        },
        "hasChildren": true,
        "hasConfigurationEntry": false,
        "descendantHasConfigurationEntry": false
    }
]

Get All Data Owner Technology Nodes (GET)

Returns all technology root nodes for data owner.

Route

URI	/api/v1/Workflow/Dataowner/Root
Method	GET
Result	JSON – Array of DataOwnerNodeModel

Parameters

None

Example

GET http://localhost/api/v1/Workflow/Dataowner/Roots
[
    {
        "$type": "pn.openService.models.ResourceTypeModel, pn.openService.interfaces",
        "displayName": "Active Directory",
        "resourceType": "ActiveDirectory",
        "typeId": 2147483646
    },
    {
        "$type": "pn.openService.models.ResourceTypeModel, pn.openService.interfaces",
        "displayName": "File server",
        "resourceType": "FileServer",
        "typeId": 2147483646
    },
    {
        "$type": "pn.openService.models.ResourceTypeModel, pn.openService.interfaces",
        "displayName": "Template",
        "resourceType": "Template",
        "typeId": 2147483646
    }
]

Get Data Owner Technology Nodes For Type (GET)

Returns technology nodes for a specific type.

Route

URI	/api/v1/Workflow/Dataowner/Roots/{typeId}
Method	GET
Result	JSON – Array of DataOwnerNodeModel

Parameters

The type identifier.

Example

GET http://localhost/api/v1/Workflow/Dataowner/Roots/1
[
    {
        "$type": "pn.openService.dataOwner.ResourceOwnerConfigurationResourceModel, pn.openService.interfaces",
        "resource": {
            "$type": "pn.openService.models.LightResourceModel, pn.openService.interfaces",
            "uriKey": "",
            "displayName": "exchangetest100.local",
            "displayPath": "",
            "resourceType": 1,
            "typeId": 15100
        },
        "hasChildren": true,
        "hasConfigurationEntry": false,
        "descendantHasConfigurationEntry": false
    },
    {
        "$type": "pn.openService.dataOwner.ResourceOwnerConfigurationResourceModel, pn.openService.interfaces",
        "resource": {
            "$type": "pn.openService.models.LightResourceModel, pn.openService.interfaces",
            "uriKey": "”,
            "displayName": "lab.protected-networks.local",
            "displayPath": "",
            "resourceType": 1,
            "typeId": 15100
        },
        "hasChildren": true,
        "hasConfigurationEntry": false,
        "descendantHasConfigurationEntry": false
    }
]

Add Data Owner To Resource (POST)

Adds a data owner assignment to a resource.

Route

URI	/api/v1/Workflow/Dataowner/Resource/add
Method	POST
Result	JSON – DataOwnerAssignmentResult

Parameters

Body: Data owner assignment details

Example

POST http://localhost/api/v1/Workflow/Dataowner/Resource/add
Content-Type: application/json

{assignment details}

Add Data Owner To Technology (POST)

Adds a data owner assignment to a technology.

Route

URI	/api/v1/Workflow/Dataowner/Technology/{typeId}/add
Method	POST
Result	JSON – DataOwnerAssignmentResult

Parameters

The type identifier.

Body: Data owner assignment details

Example

POST http://localhost/api/v1/Workflow/Dataowner/Technology/AD/add
Content-Type: application/json

{assignment details}

Add Data Owner To Root (POST)

Adds a data owner assignment to a root node.

Route

URI	/api/v1/Workflow/Dataowner/Root/add
Method	POST
Result	JSON – DataOwnerAssignmentResult

Parameters

Body: Data owner assignment details

Example

POST http://localhost/api/v1/Workflow/Dataowner/Root/add
Content-Type: application/json

{assignment details}

Delete Data Owner From Resource (DELETE)

Removes a data owner assignment from a resource.

Route

URI	/api/v1/Workflow/Dataowner/Resource/delete
Method	DELETE
Result	JSON – DataOwnerDeletionResult

Parameters

Query parameters or body with assignment details.

Example

DELETE http://localhost/api/v1/Workflow/Dataowner/Resource/delete

Delete Data Owner From Technology (DELETE)

Removes a data owner assignment from a technology.

Route

URI	/api/v1/Workflow/Dataowner/Technology/{typeId}/delete
Method	DELETE
Result	JSON – DataOwnerDeletionResult

Parameters

Property	Type	Mandatory	Description
typeId	string	Yes	The type identifier (in URL path)

Example

DELETE http://localhost/api/v1/Workflow/Dataowner/Technology/AD/delete

Delete Data Owner From Root (DELETE)

Removes a data owner assignment from a root node.

Route

URI	/api/v1/Workflow/Dataowner/Root/delete
Method	DELETE
Result	JSON – DataOwnerDeletionResult

Parameters

Query parameters or body with assignment details.

Example

DELETE http://localhost/api/v1/Workflow/Dataowner/Root/delete