Dependency Corrections for an Entity¶
/api/repositories/{repository}/entities/{entity}/dependencies/{dependencyKey}/corrections/
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)/corrections/
¶ Lists corrections for single dependency of the corresponding Entity
GET /api/repositories/test/entities/1/dependencies/2-3/corrections/ 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 corrections in the corresponding Entity.
Columns¶
The columns
array will contain the list of columns for each data row. An example is shown in the below table.
Human Name | Column Name | Description |
---|---|---|
Determinant | _lhs | The lhs of the dependency rule |
Dependent | _rhs | The rhs of the dependency rule |
Corrector | _correction | @TSQ correction script |
Data Row¶
The data row
will contain the list of corrections of the corresponding Entity:
"rows": [
{
"dataRow": [
"line_03 == 19 Lois Lane",
"line_02 = Ms Lois Lane",
"if (line_03 == '19 Lois Lane') then move 'Ms Lois Lane' ,line_02;\ \ endif;"
]
}
]
If there are no corrections in the Entity, rows
will be an empty string.
Post¶
-
POST
/api/repositories/
(string: repository)/entities/
(int: entityID)/dependencies/
¶ Lists corrections for multiple dependencies of the corresponding entity, also allows user to pass in supported options (Paging & Cache) see Standard Request for more information on these options.
POST /api/repositories/{repository}/entities/{entity}/dependencies/ HTTP/1.1
Content-Type: application/json
{
"command": "corrections",
"data": {
"dependencyKeys": ["2 3","6 3"]
}
}
Response Code | Reason |
---|---|
200 | Success |
400 | Bad Request |
500 | Server error |
The request packet must contain the command
and data
element.
The dependencyKeys
one or more dependency keys.
The response will be a Standard Response, with a list of any corrections in the corresponding Entity.
The columns
array will contain the list of columns for each data row as listed in above columns.
The data row
will contain the list of corrections of the corresponding Entity similar to ones listed in above data row
Dependency Corrections for an Attribute¶
/api/repositories/{repository}/entities/{entity}/attributes/{attribute}/dependencies/{dependencyKey}/corrections/
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)/corrections/
¶ Lists corrections for single dependency of the corresponding attribute
GET /api/repositories/alpha/entities/1/attributes/1/dependencies/2-3/corrections/ 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 corrections in the corresponding Attributes.
Columns¶
The columns
array will contain the list of columns for each data row. An example is shown in the below table.
Human Name | Column Name | Description |
---|---|---|
Determinant | _lhs | The lhs of the dependency rule |
Dependent | _rhs | The rhs of the dependency rule |
Corrector | _correction | @TSQ correction script |
Data Row¶
The data row
will contain the list of corrections for given dependency of the corresponding Attributes:
"rows": [
{
"dataRow": [
"line_03 == 19 Lois Lane",
"line_02 = Ms Lois Lane",
"if (line_03 == '19 Lois Lane') then move 'Ms Lois Lane' ,line_02;\ \ endif;"
]
}
]
If there are no corrections in the Attributes, rows
will be an empty string.
Post¶
-
POST
/api/repositories/
(string: repository)/entities/
(int: entityID)/attributes/
(int: attributeID)/dependencies/
¶ Lists corrections for multiple dependencies of the corresponding Attributes, also allows 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/ HTTP/1.1
Content-Type: application/json
{
"command": "corrections",
"data": {
"dependencyKeys": ["2 3","6 3"]
}
}
Response Code | Reason |
---|---|
200 | Success |
400 | Bad Request |
500 | Server error |
The request packet must contain the command
and data
element.
The dependencyKeys
one or more dependency keys.
The response will be a Standard Response, with a list of any corrections in the corresponding Attributes.
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 corrections of the corresponding Attributes similar to ones listed in above data row