Dependency Conflicts for an Entity¶

/api/repositories/{repository}/entities/{entity}/dependencies/{dependencyKey}/conflicts/

Parameter	Type	Purpose
repository	string	the name of the Repository
entity	int	The ID of the entity to view
dependencyKey	string	The dependency key

Get¶

GET /api/repositories/(string: repository)/entities/(int: entityID)/dependencies/(string: dependencyKey)/conflicts/¶: Lists dependency conflicts of the corresponding Entity

GET /api/repositories/alpha/entities/1/dependencies/2-1_21/conflicts/ HTTP/1.1
Accept: application/json

Response Code	Reason
200	No error
500	Server error

The response will be a Standard Response, with a list of dependency conflicts in the corresponding Entity.

Columns¶

The columns array will contain the list of columns for each data row. It will contain Frequency and Column names on which the dependency is created. An example is shown in the below table.

Human Name	Column Name	Description
Frequency	contradiction.COUNT	Number of rows with this lhs value
Account ID	Account_id
Attr21	Attr21
Customer ID	Customer_id

Data Row¶

The data row will contain the list of conflicts of the corresponding Entity:

"rows": [
    {
        "dataRow": [
            "1",
            "71621",
            "",
            "A00938"
        ]
    },
    {
        "dataRow": [
           "1",
           "71621",
           "",
           "A00288"
        ]
    }
  ]
}

If there are no dependency conflicts in the Entity, rows will be an empty string.

Post¶

POST /api/repositories/(string: repository)/entities/(int: entityID)/dependencies/(dependencyKey)/conflicts/¶: Lists dependency conflict of the corresponding entity, allow user to pass in supported options (Paging & Cache) see Standard Request for more information on these options.

POST /api/repositories/{repository}/entities/{entity}/dependencies/{dependencyKey}/conflicts/ HTTP/1.1
Content-Type: application/json

{
    "command": "get",
    "options": {
        "pageStart": "1",
        "pageSize": "65"
    }
}

Response Code	Reason
200	Success
400	Bad Request
500	Server error

The request packet must contain the command element. The options elements is optional.

The response will be a Standard Response, with a list of any conflict in the corresponding Entity.

The columns array will contain the list of columns for each data row as listed in above columns. It will contain Frequency and Column names on which the dependency is created.

The data row will contain the list of conflicts of the corresponding Entity similar to ones listed in above data row

Export¶

Some or all of the rows may be exported as a scheduled task.

POST /api/repositories/jupiter/entities/1/dependencies/1-10/conflicts HTTP/1.1
Content-Type: application/json

{
    "command": "export",
    "data": {
        "filename": "filename.csv",
        "filetype": "csv",
        "encoding": "utf-8"
    },
    "options": {
        "where": "Frequency = 1"
    }
}

Response Code	Reason
200	No error
400	Invalid data passed with request
500	Server error

The request packet must contain the command and data elements. The options element is not required, but may specify the columns to export, and/or the rows to filter.

The following table shows which fields are required in the data element:

Field	Required
filename	Y
filetype	N
encoding	N

If filetype is not specified, it defaults to csv. If encoding is not specified, it defaults to the server native encoding.

The response will contain the URL of the scheduled task and the link to download the exported file.

{
    "job": "/api/repositories/jupiter/scheduler/1",
    "file": "/api/repositories/jupiter/download/filename.csv"
}

Dependency Conflicts for an Attribute¶

/api/repositories/{repository}/entities/{entity}/attributes/{attribute}/dependencies/{dependencyKey}/conflicts/

Parameter	Type	Purpose
repository	string	the name of the Repository
entity	int	The ID of the entity to view
attribute	int	The ID of the attribute to view
dependencyKey	string	The dependency key

Get¶

GET /api/repositories/(string: repository)/entities/(int: entityID)/attributes/(int: attributeID)/dependencies/(string: dependencyKey)/conflicts/¶: Lists dependency conflicts of the corresponding attribute

GET /api/repositories/alpha/entities/1/attributes/1/dependencies/1-3/conflicts/ HTTP/1.1
Accept: application/json

Response Code	Reason
200	No error
500	Server error

The response will be a Standard Response, with a list of dependency conflicts in the corresponding Attributes.

Columns¶

The columns array will contain the list of columns for each data row. It will contain Frequency and Column names on which the dependency is created. An example is shown in the below table.

Human Name	Column Name	Description
Frequency	contradiction.COUNT	Number of rows with this lhs value
Line 03	Line_03
Line 01	Line_01

Data Row¶

The data row will contain the list of conflicts of the corresponding Attributes:

"rows": [
    {
        "dataRow": [
            "1",
            "19 Lois Lane",
            "Ms Della Street"
        ]
    },
    {
        "dataRow": [
            "1",
            "19 Lois Lane",
            "Lois Lane H674532867"
        ]
    }
]

If there are no dependency conflicts in the Attributes, rows will be an empty string.

Post¶

POST /api/repositories/(string: repository)/entities/(int: entityID)/attributes/(int: attributeID)/dependencies/(dependencyKey)/conflicts/¶: Lists dependency conflict of the corresponding attribute, allow user to pass in supported options (Paging & Cache) see Standard Request for more information on these options.

POST /api/repositories/{repository}/entities/{entity}/attributes/{attribute}/dependencies/{dependencyKey}/conflicts/ HTTP/1.1
Content-Type: application/json

{
    "command": "get",
    "options": {
        "pageStart": "1",
        "pageSize": "65"
    }
}

Response Code	Reason
200	Success
400	Bad Request
500	Server error

The request packet must contain the command element. The options elements is optional.

The response will be a Standard Response, with a list of any conflict in the corresponding attribute.

The columns array will contain the list of columns for each data row as listed in above columns. It will contain Frequency and Column names on which the dependency is created.

The data row will contain the list of conflicts of the corresponding attribute similar to ones listed in above data row

Resolve Dependency Conflicts for an Entity¶

POST /api/repositories/test/entities/1/dependencies HTTP/1.1
Content-Type: application/json

{
    "command": "resolveConflicts",
    "data": {
        "eid": "1",
        "lhNames":"Line 02, Line 05, Vin Number",
        "rhName":"Line 01",
        "rhAttr":"1",
        "lhAttrs":"2 5 6",
        "rhValue":"Dr Mark Pederson and Dr Anmarie Russo  ",
        "lhValues":"{Russo Eye Associates} {} F748264832",
        "lhText":"Russo Eye Associates,,F748264832",
        "rhValueResolved": "Dr Mark Pederson and Dr Anmarie Russo TESTING"
    }
}

Response Code	Reason
200	No error
400	Invalid data passed with request
500	Server error

The request requires a Standard Request packet. Available commands are:

Command	Description
resolveConflicts	Resolve dependency conflicts.

The request packet must contain the command and data elements. The following fields should be sent as part of data:

Name	Mandatory	Default Value	Description
eid	Yes	NA	Entity Id
lhNames	Yes	NA	Left hand attribute names.
rhName	Yes	NA	Right hand attribute name.
rhAttr	Yes	NA	Right hand attribute Id.
lhAttrs	Yes	NA	Left hand attribute Ids.
rhValue	Yes	NA	Right hand attribute value.
lhValues	Yes	NA	Left hand attribute values.
lhText	Yes	NA	Left hand attribute values as text.
rhValueResolved	Yes	NA	Resolved value for the right hand attribute.

The response will contain the URL to the resolved dependency coflict.

"uri": "/api/repositories/test/entities/1/dependencies/1-2_5_6/conflicts/"

Resolve Dependency Conflicts for an Attribute¶

POST /api/repositories/test/entities/1/attributes/1/dependencies HTTP/1.1
Content-Type: application/json

{
    "command": "resolveConflicts",
    "data": {
        "eid": "1",
        "lhNames":"Line 02",
        "rhName":"Line 01",
        "rhAttr":"1",
        "lhAttrs":"2",
        "rhValue":"Dr Mark Pederson and Dr Anmarie Russo  ",
        "lhValues":"{Russo Eye Associates}",
        "lhText":"Russo Eye Associates",
        "rhValueResolved": "Dr Mark Pederson and Dr Anmarie Russo ATTRIBUTE"
    }
}

Response Code	Reason
200	No error
400	Invalid data passed with request
500	Server error

The request requires a Standard Request packet. Available commands are:

Command	Description
resolveConflicts	Resolve dependency conflicts.

The request packet must contain the command and data elements. The following fields should be sent as part of data:

Name	Mandatory	Default Value	Description
eid	Yes	NA	Entity Id
lhNames	Yes	NA	Left hand attribute names.
rhName	Yes	NA	Right hand attribute name.
rhAttr	Yes	NA	Right hand attribute Id.
lhAttrs	Yes	NA	Left hand attribute Ids.
rhValue	Yes	NA	Right hand attribute value.
lhValues	Yes	NA	Left hand attribute values.
lhText	Yes	NA	Left hand attribute values as text.
rhValueResolved	Yes	NA	Resolved value for the right hand attribute.

The response will contain the URL to the resolved dependency coflict.

"uri": "/api/repositories/test/entities/1/attributes/1/dependencies/1-2/conflicts/"

TSS REST API

Dependency Conflicts for an Entity¶

Get¶

Columns¶

Data Row¶

Post¶

Export¶

Dependency Conflicts for an Attribute¶

Get¶

Columns¶

Data Row¶

Post¶

Resolve Dependency Conflicts for an Entity¶

Resolve Dependency Conflicts for an Attribute¶

Table Of Contents