Permanent Dependencies for an Entity ==================================== .. code-block:: http /api/repositories/{repository}/entities/{entity}/dependencies/permanent .. csv-table:: :header: Parameter, Type, Purpose :widths: 20, 20, 60 :stub-columns: 1 repository, string, the name of the :doc:`repository` entity, int, The ID of the entity to view Get ~~~ .. http:get:: /api/repositories/(string:repository)/entities/(int:entityID)/dependencies/permanent :synopsis: Lists permanent dependencies of an entity Lists permanent dependencies of the corresponding :doc:`entity` .. code-block:: http GET /api/repositories/jupiter/entities/1/dependencies/permanent HTTP/1.1 Accept: application/json .. csv-table:: :header: Response Code, Reason :widths: 25, 75 200, No error 500, Server error The response will be a :doc:`standard-response`, with a list of permanent dependencies in the corresponding :doc:`entity`. .. _dep_perm_columns_label: Columns ------- The ``columns`` array will contain the list of columns for each data row. .. csv-table:: :header: Human Name, Column Name, Description :widths: 25, 25, 50 "Lh Attrs", "_lhnames", "The attributes that determine the rh attribute" "Rh Attr", "_rhname", "The attribute that is determined by the lh attribute(s)" "Status", "__STATUS", "Whether the dependency is Discovered or Permanent." "Verified", "_verified", "Whether the rule quality has been verified against all rows." "Job", "JOB_ID", "The scheduler job that created this rule." "Quality %", "GOODNESS", "A measure of how well the attributes form a dependency" "Confirming LR Values", "CONFIRMATIONS", "The number of lh values that do determine their rh value." "Conflicting LH Values", "SETS", "The number of distinct lh values that do not determine their rh value" "Resolved %", "_resolved", "The percentage of conflicting LH Values that have been resolved" "Normalise Flag", "_normalise", "Dependency can be included in a normalisation (1=true, 0=false)" "Conflicting Rows", "CONTRADICTIONS", "The number of rows where the lh value does not determine their rh value" "Verified Date", "_checked_date", "When the dependency was last verified." "Verified By", "CHECKED_BY", "Who verified the dependency." "Created Date", "_created_date", "When the dependency rule was created." "Created By", "CREATED_BY", "Who created the dependency rule." "Dependency Key", "_fd_key", "Internal key for this dependency" "Rh Attr ID", "RH_ATTR", "Ids of the right hand attributes that form the primary key" "Lh Attr Ids", "LH_ATTRS", "Ids of the left hand attributes that form the primary key" .. _ent_dep_perm_datarow_label: Data Row -------- The ``data row`` will contain the list of permanent dependencies in the corresponding :doc:`entity`: .. code-block:: json "rows": [ { "dataRow": [ "Account ID", "Customer ID", "Permanent", "Yes", "9", "99.626", "1598", "6", "", "0", "12", "2015/03/03 10:52:29", "bob", "2015/03/03 10:52:29", "bob", "2 1" "2", "1" ], "metadata": { "url": "/api/repositories/alpha/entities/1/dependencies/2-1/conflicts/" } } If there are no permanent dependencies in the :doc:`entity`, ``rows`` will be an empty string. Post ~~~~ .. http:post:: /api/repositories/(string:repository)/entities/(int:entityID)/dependencies/permanent :synopsis: Lists permanent dependencies of an entity using post. Lists permanent dependencies of the corresponding :doc:`entity `, allow user to pass in supported options (Paging, Columns, Sorting & Cache) see :doc:`standard-request` for more information on these options. .. code-block:: http POST /api/repositories/{repository}/entities/{entity}/dependencies/permanent HTTP/1.1 Content-Type: application/json { "command": "get", "options": { "pageStart": "1", "pageSize": "65" } } .. csv-table:: :header: Response Code, Reason :widths: 25, 75 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 :doc:`standard-response`, with a list of permanent dependencies in the corresponding :doc:`entity`. The ``columns`` array will contain the list of columns for each data row as listed in above :ref:`columns `. The ``data row`` will contain the list of permanent dependencies in the corresponding :doc:`entity` similar to ones listed in above :ref:`data row ` Permanent Dependencies for an Attribute ======================================= .. code-block:: http /api/repositories/{repository}/entities/{entity}/attributes/{attribute}/dependencies/permanent .. csv-table:: :header: Parameter, Type, Purpose :widths: 20, 20, 60 :stub-columns: 1 repository, string, the name of the :doc:`repository` entity, int, The ID of the entity to view attribute, int, The ID of the attribute to view Get ~~~ .. http:get:: /api/repositories/(string:repository)/entities/(int:entityID)/attributes/(int:attributeID)/dependencies/permanent :synopsis: Lists permanent dependencies of an attribute Lists permanent dependencies of the corresponding :doc:`attribute ` .. code-block:: http GET /api/repositories/jupiter/entities/1/attributes/1/dependencies/permanent HTTP/1.1 Accept: application/json .. csv-table:: :header: Response Code, Reason :widths: 25, 75 200, No error 400, Bad Request 500, Server error The response will be a :doc:`standard-response`, with a list of permanent dependencies in the corresponding :doc:`attributes`. Columns ------- The ``columns`` array will contain the list of columns for each data row as listed in above :ref:`columns `. .. _attr_dep_perm_datarow_label: Data Row -------- The ``data row`` will contain the list of permanent dependencies in the corresponding :doc:`attributes`: .. code-block:: json "rows": [ { "dataRow": [ "Line 01", "Line 02", "Permanent", "Yes", "7", "100.000", "50", "", "", "1", "", "2015/03/16 09:22:54", "bob@TEST-7", "2015/03/16 09:22:54", "bob@TEST-7", "2 1", "2", "1" ], "metadata": { "url": "/api/repositories/test/entities/1/attributes/1/dependencies/2-1/conflicts/" } } ] If there are no permanent dependencies in the :doc:`attributes`, ``rows`` will be an empty string. Post ~~~~ .. http:post:: /api/repositories/(string:repository)/entities/(int:entityID)/attributes/(int:attributeID)/dependencies/permanent :synopsis: Lists permanent dependencies of an attribute using post. Lists permanent dependencies of the corresponding :doc:`attribute `, allow user to pass in supported options (Paging, Columns, Sorting & Cache) see :doc:`standard-request` for more information on these options. .. code-block:: http POST /api/repositories/{repository}/entities/{entity}/attributes/{attribute}/dependencies/permanent HTTP/1.1 Content-Type: application/json { "command": "get", "options": { "pageStart": "1", "pageSize": "65" } } .. csv-table:: :header: Response Code, Reason :widths: 25, 75 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 :doc:`standard-response`, with a list of permanent dependencies in the corresponding :doc:`attributes`. The ``columns`` array will contain the list of columns for each data row as listed in above :ref:`columns `. The ``data row`` will contain the list of permanent dependencies in the corresponding :doc:`attributes` similar to ones listed in above :ref:`data row `