http://git-wip-us.apache.org/repos/asf/incubator-griffin/blob/6b1a7000/griffin-doc/service/postman/griffin.json ---------------------------------------------------------------------- diff --git a/griffin-doc/service/postman/griffin.json b/griffin-doc/service/postman/griffin.json index fdd172a..7553421 100644 --- a/griffin-doc/service/postman/griffin.json +++ b/griffin-doc/service/postman/griffin.json @@ -1,142 +1,141 @@ { - "id": "a743e1b9-583f-6bd7-e2ae-f03a1f807c63", - "name": "Griffin_2018_01_09", + "id": "c999a5d1-4ca3-e246-dd4f-6464e0be085f", + "name": "Griffin Service", "description": "", "order": [], "folders": [ { "name": "Auth", "description": "user authentication", - "collectionId": "a743e1b9-583f-6bd7-e2ae-f03a1f807c63", + "collectionId": "c999a5d1-4ca3-e246-dd4f-6464e0be085f", "order": [ - "c7b8e9b6-edde-e01b-1b4f-09d9396aada6" + "c99b7f08-0cc1-8b94-ac98-04b55a0584d9" ], - "owner": "503523", + "owner": "2830994", "folders_order": [], - "id": "208120a7-5805-89eb-4472-775e0f73a819" + "id": "7395e9e2-0ffa-a67e-459e-b09d199a3523" }, { "name": "Basic", "description": "", - "collectionId": "a743e1b9-583f-6bd7-e2ae-f03a1f807c63", + "collectionId": "c999a5d1-4ca3-e246-dd4f-6464e0be085f", "order": [ - "e7dd72bc-b1a2-7e84-525e-4f176bb2f635" + "2bb01633-bd16-67d2-5ceb-11668629a556" ], - "owner": "503523", + "owner": "2830994", "folders_order": [], - "id": "ee22ca52-aa2b-18a3-1070-bc9fdc018a7d" + "id": "9cab795a-6c51-01da-5e13-f5abf5793a73" }, { "name": "Hive MetaStore", "description": "", - "collectionId": "a743e1b9-583f-6bd7-e2ae-f03a1f807c63", + "collectionId": "c999a5d1-4ca3-e246-dd4f-6464e0be085f", "order": [ - "9f536c3d-d3e0-bcf9-102a-d2d25ac3ef14", - "2d90ae20-5f65-df06-b533-e7f3e9ea3b50", - "7daeb86c-dc01-fa99-9898-73ec4a6e7e57", - "91e19d73-87b1-f388-93a9-22c7a0ec2b43", - "f0666097-2cbf-7875-a9a3-c505ba7820b3" + "7e478411-b8a5-552c-7d42-53e90e684ba0", + "24d58851-4ec5-f23e-1657-40f5343b541e", + "733baba6-aa05-fe53-869e-ca6ea85ce389", + "8bbf31e3-bf20-b634-8075-cdc3e169446c", + "2e76c537-40a2-2d85-acb3-2f39a0b5ec98" ], - "owner": "503523", + "owner": "2830994", "folders_order": [], - "id": "7ae8e04f-c5cb-aeab-9af3-65cb3bf87b1f" + "id": "83ca6edc-27b6-8b6c-a84c-527ed84397fa" }, { "name": "Jobs", "description": "", - "collectionId": "a743e1b9-583f-6bd7-e2ae-f03a1f807c63", + "collectionId": "c999a5d1-4ca3-e246-dd4f-6464e0be085f", "order": [ - "01e1bf7a-0a88-2039-ec03-777222c33bf5", - "8a94fa54-5df7-0e9e-06b5-158239e0570a", - "cde4e7ad-6b6a-96d6-ee3b-aeeeeb8f6805", - "aad1b117-7c8e-4185-ff59-28e0b3e8f4b1", - "5767e1b2-a078-caec-34ae-b4366d66ba3d", - "2bfc82ab-ec97-ee89-d6b4-db5ffefce28b" + "eaa2997f-f200-e0ba-0771-5ec1fc358a77", + "4bf76f4b-f639-d339-736a-e58ba36f0248", + "f5836199-8766-ffb1-b817-fc2a7e5ff488", + "50d9ecef-c4ab-a026-52c1-36c9bd8fb472", + "8c60900b-220d-3e66-5a13-57fa5e006056", + "7bf89dbd-47e2-2c20-1631-fedccf836c8a" ], - "owner": "503523", + "owner": "2830994", "folders_order": [], - "id": "40702c96-d08c-fd56-add4-5d26598e539e" + "id": "4e437aa6-f696-053e-8f1e-8b6a10c79015" }, { "name": "Measures", "description": "", - "collectionId": "a743e1b9-583f-6bd7-e2ae-f03a1f807c63", + "collectionId": "c999a5d1-4ca3-e246-dd4f-6464e0be085f", "order": [ - "f268747b-b506-7c8f-4463-8a860e09fc09", - "e0cfd3ea-0fea-4920-0dc1-c42a0212b401", - "57cf1684-d812-5867-3c76-e285527a7c58", - "2ebbf1cd-c78a-861e-6382-4a4d9dfba4be", - "12232e4c-2720-f5ac-0c6c-71b877a14d94", - "f989dff6-0847-cc8a-0989-ccae76f33562" + "303cab65-5daa-a9cc-b080-9e3786cd0aab", + "b40f3bc6-3235-5fde-cf7a-965fa3eef41e", + "7843c251-24ad-90c2-de8a-ad91641d1307", + "f94d1000-2f71-2c93-0f4a-2e8eae404694", + "8f188622-4280-6efc-9dee-fd73965cb21b", + "bd129fd6-9aaa-bcf5-7cfd-2925d08dabed" ], - "owner": "503523", + "owner": "2830994", "folders_order": [ - "04a4a902-f33b-bce5-06dc-4da56cae7c4f" + "4abf2a62-be58-8693-7f1e-c0387535ba99" ], - "id": "523a7f9f-1970-018e-9241-57caa3d6ea60" + "id": "90bf25ee-3a44-f5a6-9862-415ada03390f" }, { "name": "Metrics", "description": "", - "collectionId": "a743e1b9-583f-6bd7-e2ae-f03a1f807c63", + "collectionId": "c999a5d1-4ca3-e246-dd4f-6464e0be085f", "order": [ - "0b69e4c7-b0fd-c313-76f7-694296789293", - "ea9d5dd7-6b22-e10a-777d-c9f3b8233858", - "f203eccc-73e3-6e0c-f526-ef635c43fd82", - "d6bd3339-7186-1eb8-8659-a2f1330d830c" + "b0b96177-9ac0-c08c-2137-2c08bdf7ad2c", + "d5f212f2-604e-8573-60d8-bb267ac1ed20", + "c391d905-8393-91a0-61dc-a05302393bb6", + "34632a9a-f66c-72a3-91b8-6956489d7786" ], - "owner": "503523", + "owner": "2830994", "folders_order": [], "auth": null, - "id": "a220d584-8aba-5112-5f30-dc287d4742de" + "id": "48b99278-ba7b-eee0-10a5-91de99619dd8" }, { "name": "OrgnizationDimension", "description": "", - "collectionId": "a743e1b9-583f-6bd7-e2ae-f03a1f807c63", + "collectionId": "c999a5d1-4ca3-e246-dd4f-6464e0be085f", "order": [ - "d480edbd-2188-d55e-f106-b1a7809a3fcb", - "619972f0-9f96-d4b5-3287-d2958f3a60c7", - "45aef93d-2bcf-4a1f-245a-29611d3d740e" + "da14517c-3b4b-db19-b029-086e2195375c", + "d9ba8d50-3489-e21d-8465-3d132f7ff90f", + "02d4d5c3-9181-5c37-0c9c-8d4ff7e2b4cf" ], - "owner": "503523", - "folder": "523a7f9f-1970-018e-9241-57caa3d6ea60", + "owner": "2830994", + "folder": "90bf25ee-3a44-f5a6-9862-415ada03390f", "folders_order": [], - "id": "04a4a902-f33b-bce5-06dc-4da56cae7c4f" + "id": "4abf2a62-be58-8693-7f1e-c0387535ba99" } ], "folders_order": [ - "ee22ca52-aa2b-18a3-1070-bc9fdc018a7d", - "523a7f9f-1970-018e-9241-57caa3d6ea60", - "40702c96-d08c-fd56-add4-5d26598e539e", - "a220d584-8aba-5112-5f30-dc287d4742de", - "7ae8e04f-c5cb-aeab-9af3-65cb3bf87b1f", - "208120a7-5805-89eb-4472-775e0f73a819" + "9cab795a-6c51-01da-5e13-f5abf5793a73", + "90bf25ee-3a44-f5a6-9862-415ada03390f", + "4e437aa6-f696-053e-8f1e-8b6a10c79015", + "48b99278-ba7b-eee0-10a5-91de99619dd8", + "83ca6edc-27b6-8b6c-a84c-527ed84397fa", + "7395e9e2-0ffa-a67e-459e-b09d199a3523" ], "timestamp": 1509932685084, - "owner": "503523", + "owner": "2830994", "public": false, + "events": [], + "variables": [], + "auth": null, "requests": [ { - "id": "01e1bf7a-0a88-2039-ec03-777222c33bf5", + "id": "02d4d5c3-9181-5c37-0c9c-8d4ff7e2b4cf", "headers": "", "headerData": [], - "url": "{{BASE_PATH}}/api/v1/jobs", + "url": "{{BASE_PATH}}/api/v1/org/measure/names", "queryParams": [], - "preRequestScript": null, "pathVariables": {}, "pathVariableData": [], "method": "GET", "data": null, "dataMode": "params", "version": 2, - "tests": null, - "currentHelper": "normal", - "helperAttributes": "{}", - "time": 1509005652378, - "name": "Get jobs", - "description": "`GET /api/v1/jobs`", - "collectionId": "a743e1b9-583f-6bd7-e2ae-f03a1f807c63", + "time": 1509332871323, + "name": "Get measure names group by org", + "description": "`GET /api/v1/orgWithMetricsName`", + "collectionId": "c999a5d1-4ca3-e246-dd4f-6464e0be085f", "responses": [ { "status": "", @@ -144,7 +143,7 @@ "code": 200, "name": "OK" }, - "time": 129, + "time": 5216, "headers": [ { "name": "access-control-allow-headers", @@ -179,7 +178,7 @@ { "name": "date", "key": "date", - "value": "Tue, 24 Oct 2017 12:01:29 GMT", + "value": "Mon, 30 Oct 2017 03:07:48 GMT", "description": "The date and time that the message was sent" }, { @@ -191,7 +190,7 @@ ], "cookies": [], "mime": "", - "text": "[\n {\n \"jobId\": 1,\n \"jobName\": \"job_name\",\n \"measureId\": 2,\n \"triggerState\": \"NORMAL\",\n \"nextFireTime\": 1515400080000,\n \"previousFireTime\": 1515399840000,\n \"cronExpression\": \"0 0/4 * * * ?\"\n }\n]", + "text": "{\"orgName\":[\"measureName_test_edit\",\"measureName_test_edit\",\"measureName1\"],\"test\":[\"measure1\"],\"ebay\":[\"new_measure_test_again\",\"third_measure\",\"fourth_measure\",\"fifth_measure\",\"third_measure\",\"measure\"]}", "language": "json", "rawDataType": "text", "previewType": "text", @@ -200,48 +199,35 @@ "write": true, "empty": false, "failed": false, - "id": "b7b16ee4-b9a2-132a-9d02-47665332b270", - "name": "Get jobs example", - "isSample": true, - "scrollToResult": false, - "runTests": false, - "request": { - "url": "{{BASE_PATH}}/api/v1/jobs", - "pathVariables": {}, - "pathVariableData": [], - "queryParams": [], - "headerData": [], - "headers": "", - "data": "", - "method": "GET", - "dataMode": "raw" - }, - "owner": "503523" + "name": "Get measure names group by org example", + "id": "5e769d8b-96fa-50d5-907c-f304a6ded0d8", + "request": "8d77e0e0-62fd-242b-ea83-a7fc4829c778", + "owner": "2830994", + "requestObject": "{\"url\":\"{{BASE_PATH}}/api/v1/org/measure/names\",\"pathVariables\":{},\"pathVariableData\":[],\"queryParams\":[],\"headerData\":[],\"headers\":\"\",\"data\":null,\"method\":\"GET\",\"dataMode\":\"params\"}" } ], - "collection_id": "a743e1b9-583f-6bd7-e2ae-f03a1f807c63", "isFromCollection": true, - "folder": "40702c96-d08c-fd56-add4-5d26598e539e" + "collection_id": "c999a5d1-4ca3-e246-dd4f-6464e0be085f", + "folder": "4abf2a62-be58-8693-7f1e-c0387535ba99", + "auth": null, + "currentHelper": null, + "helperAttributes": null }, { - "id": "0b69e4c7-b0fd-c313-76f7-694296789293", + "id": "24d58851-4ec5-f23e-1657-40f5343b541e", "headers": "", "headerData": [], - "url": "{{BASE_PATH}}/api/v1/metrics", + "url": "{{BASE_PATH}}/api/v1/metadata/hive/dbs", "queryParams": [], "pathVariables": {}, "pathVariableData": [], - "events": [], - "auth": null, "method": "GET", - "collectionId": "a743e1b9-583f-6bd7-e2ae-f03a1f807c63", "data": null, "dataMode": "params", - "name": "Get metrics", - "description": "`GET /api/v1/metrics`\n\nGet all metrics that are computed by griffin jobs or subscribed by external measure.", - "descriptionFormat": "html", - "time": 1515485493066, - "version": 2, + "time": 1508997670920, + "name": "Get database names", + "description": "`GET /api/v1/metadata/hive/dbs`\n \n #### Get all database names", + "collectionId": "c999a5d1-4ca3-e246-dd4f-6464e0be085f", "responses": [ { "status": "", @@ -249,137 +235,94 @@ "code": 200, "name": "OK" }, - "time": 800, + "time": 225, "headers": [ { - "key": "Access-Control-Allow-Headers", + "name": "access-control-allow-headers", + "key": "access-control-allow-headers", "value": "X-PINGOTHER, Origin, X-Requested-With, Content-Type, Accept", - "name": "Access-Control-Allow-Headers", "description": "Used in response to a preflight request to indicate which HTTP headers can be used when making the actual request." }, { - "key": "Access-Control-Allow-Methods", + "name": "access-control-allow-methods", + "key": "access-control-allow-methods", "value": "POST, GET, OPTIONS, DELETE,PUT", - "name": "Access-Control-Allow-Methods", "description": "Specifies the method or methods allowed when accessing the resource. This is used in response to a preflight request." }, { - "key": "Access-Control-Allow-Origin", + "name": "access-control-allow-origin", + "key": "access-control-allow-origin", "value": "*", - "name": "Access-Control-Allow-Origin", "description": "Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource." }, { - "key": "Access-Control-Max-Age", + "name": "access-control-max-age", + "key": "access-control-max-age", "value": "3600", - "name": "Access-Control-Max-Age", "description": "Indicates how long the results of a preflight request can be cached in seconds." }, { - "key": "Content-Type", + "name": "content-type", + "key": "content-type", "value": "application/json;charset=UTF-8", - "name": "Content-Type", "description": "The mime type of this content" }, { - "key": "Date", - "value": "Tue, 09 Jan 2018 08:39:20 GMT", - "name": "Date", + "name": "date", + "key": "date", + "value": "Wed, 25 Oct 2017 05:12:36 GMT", "description": "The date and time that the message was sent" }, { - "key": "Transfer-Encoding", + "name": "transfer-encoding", + "key": "transfer-encoding", "value": "chunked", - "name": "Transfer-Encoding", "description": "The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity." } ], - "cookies": [ - { - "domain": "localhost", - "expirationDate": 2147483647, - "httpOnly": true, - "name": "JSESSIONID", - "path": "/", - "secure": false, - "url": "http://localhost:8080";, - "value": "DC35BDC91FC450DE5D89D477E27FD19E" - } - ], + "cookies": [], "mime": "", - "text": "[{\"name\":\"external_name\",\"description\":\" test measure\",\"organization\":\"orgName\",\"owner\":\"test\",\"metricValues\":[{\"name\":\"metricName\",\"tmst\":1509599811123,\"value\":{\"__tmst\":1509599811123,\"miss\":11,\"total\":125000,\"matched\":124989}}]}]", + "text": "[\"default\"]", "language": "json", + "rawDataType": "text", "previewType": "text", "searchResultScrolledTo": -1, "forceNoPretty": false, "write": true, "empty": false, "failed": false, - "code": 200, - "responseSize": { - "body": 231, - "header": 345, - "total": 576 - }, - "mimeType": "text", - "fileName": "response.json", - "dataURI": "data:application/json;base64, W3sibmFtZSI6ImV4dGVybmFsX25hbWUiLCJkZXNjcmlwdGlvbiI6IiB0ZXN0IG1lYXN1cmUiLCJvcmdhbml6YXRpb24iOiJvcmdOYW1lIiwib3duZXIiOiJ0ZXN0IiwibWV0cmljVmFsdWVzIjpbeyJuYW1lIjoibWV0cmljTmFtZSIsInRtc3QiOjE1MDk1OTk4MTExMjMsInZhbHVlIjp7Il9fdG1zdCI6MTUwOTU5OTgxMTEyMywibWlzcyI6MTEsInRvdGFsIjoxMjUwMDAsIm1hdGNoZWQiOjEyNDk4OX19XX1d", - "id": "508596a6-43a1-7c8b-a430-32834dbac515", - "name": "Get metcis example", + "id": "59261f8c-aea3-1d5e-a816-be8affeeca4b", + "name": "Get db names example", "isSample": true, "scrollToResult": false, "runTests": false, - "request": "0b69e4c7-b0fd-c313-76f7-694296789293", - "owner": "503523", - "requestObject": { - "url": "{{BASE_PATH}}/api/v1/metrics", - "pathVariables": {}, - "pathVariableData": [], - "queryParams": [], - "headerData": [], - "headers": "", - "data": null, - "method": "GET", - "dataMode": "params" - } + "request": "5985157f-88de-dd0c-70c2-add0f6b7d9f8", + "owner": "2830994", + "requestObject": "{\"url\":\"{{BASE_PATH}}/api/v1/metadata/hive/dbs\",\"pathVariables\":{},\"pathVariableData\":[],\"queryParams\":[],\"headerData\":[],\"headers\":\"\",\"data\":null,\"method\":\"GET\",\"dataMode\":\"params\"}" } ], - "folder": "a220d584-8aba-5112-5f30-dc287d4742de", - "collection_id": "0afa8193-bfa7-7735-dd77-d5014d360e4c", + "collection_id": "c999a5d1-4ca3-e246-dd4f-6464e0be085f", + "folder": "83ca6edc-27b6-8b6c-a84c-527ed84397fa", + "auth": null, "currentHelper": null, - "helperAttributes": "null", - "preRequestScript": "", - "tests": "", - "isFromCollection": true, - "collectionRequestId": "70038dbb-8fd2-3bd2-1333-5ee86e8a8cff" + "helperAttributes": null }, { - "id": "12232e4c-2720-f5ac-0c6c-71b877a14d94", - "headers": "Content-Type: application/json\n", - "headerData": [ - { - "key": "Content-Type", - "value": "application/json", - "description": "", - "enabled": true - } - ], - "url": "{{BASE_PATH}}/api/v1/measures", - "folder": "523a7f9f-1970-018e-9241-57caa3d6ea60", + "id": "2bb01633-bd16-67d2-5ceb-11668629a556", + "headers": "", + "headerData": [], + "url": "{{BASE_PATH}}/api/v1/version", "queryParams": [], - "preRequestScript": null, "pathVariables": {}, "pathVariableData": [], - "method": "PUT", - "data": [], - "dataMode": "raw", - "tests": null, - "currentHelper": "normal", - "helperAttributes": {}, - "time": 1516341608732, - "name": "Update measure", - "description": "`PUT /api/v1/measures`\n\n#### Request Header\nkey | value\n--- | ---\nContent-Type | application/json\n\n#### Request Body\n\nname | description | type\n--- | --- | --- \nmeasure | measure entity | Measure\n\nThere are two different measures that are griffin measure and external measure.\nIf you want to update an external measure,you can use following example json in request body.\n```\n{\n\t\"id\":1,\n \"type\": \"external\",\n \"name\": \"external_name\",\n \"description\": \" update test measure\",\n \"organization\": \"orgName\",\n \"owner\": \"test\",\n \"metricName\": \"metricName\"\n}\n```\nPostman gives a griffin measure example in request body and response body. \n#### Response Body Sample\n```\n{\n \"code\": 204,\n \"description\": \"Update Measure Succeed\"\n}\n```\n\nIt may return failed messages.Such as,\n\n```\n {\n \"code\": 400,\n \"description\": \"Resource Not Found\"\n}\n\n```\n\nThe reason for failure may be that measure id doesn't exist.", - "collectionId": "a743e1b9-583f-6bd7-e2ae-f03a1f807c63", + "method": "GET", + "data": null, + "dataMode": "params", + "version": 2, + "time": 1508997903989, + "name": "Get griffin version", + "description": "`GET /api/v1/version`", + "collectionId": "c999a5d1-4ca3-e246-dd4f-6464e0be085f", "responses": [ { "status": "", @@ -387,7 +330,7 @@ "code": 200, "name": "OK" }, - "time": 157, + "time": 63, "headers": [ { "name": "access-control-allow-headers", @@ -414,28 +357,28 @@ "description": "Indicates how long the results of a preflight request can be cached in seconds." }, { + "name": "content-length", + "key": "content-length", + "value": "5", + "description": "The length of the response body in octets (8-bit bytes)" + }, + { "name": "content-type", "key": "content-type", - "value": "application/json;charset=UTF-8", + "value": "text/plain;charset=UTF-8", "description": "The mime type of this content" }, { "name": "date", "key": "date", - "value": "Tue, 24 Oct 2017 11:05:46 GMT", + "value": "Thu, 26 Oct 2017 05:45:09 GMT", "description": "The date and time that the message was sent" - }, - { - "name": "transfer-encoding", - "key": "transfer-encoding", - "value": "chunked", - "description": "The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity." } ], "cookies": [], "mime": "", - "text": "{\"code\":204,\"description\":\"Update Measure Succeed\"}", - "language": "json", + "text": "0.1.0", + "language": "plainText", "rawDataType": "text", "previewType": "text", "searchResultScrolledTo": -1, @@ -443,68 +386,52 @@ "write": true, "empty": false, "failed": false, - "id": "d32fe979-cba5-bb88-09fd-e71c3a7135ac", - "name": "Update measure example", - "isSample": true, - "scrollToResult": false, - "runTests": false, - "request": { - "url": "{{BASE_PATH}}/api/v1/measures", - "pathVariables": {}, - "pathVariableData": [], - "queryParams": [], - "headerData": [ - { - "key": "Content-Type", - "value": "application/json", - "enabled": true, - "description": "" - } - ], - "headers": "Content-Type: application/json\n", - "data": "{\n \"id\": 1,\n \"name\": \"measureName_edit\",\n \"description\": \"measure description\",\n \"organization\": \"orgName\",\n \"owner\": \"test\",\n \"deleted\": false,\n \"dq.type\": \"accuracy\",\n \"process.type\": \"batch\",\n \"data.sources\": [\n {\n \"id\": 1,\n \"name\": \"source\",\n \"connectors\": [\n {\n \"id\": 1,\n \"name\": \"connector_name_source\",\n \"type\": \"HIVE\",\n \"version\": \"1.2\",\n \"predicates\": [\n {\n \"id\": 1,\n \"type\": \"file.exist\",\n \"config\": {\n \"root.path\": \"hdfs:///griffin/demo_src\",\n \"path\": \"/dt=#YYYYMMdd#/hour=#HH#/_DONE\"\n }\n }\n ],\n \"data.unit\": \"1h\",\n \"config\": {\n \"database\": \"default\",\n \"table.name\": \"demo_src\",\n \"where\": \"dt=#YYYYMMdd# AND hour=#HH#\"\n }\n }\n ]\n },\n {\n \"id\": 2,\n \"name\": \"target\",\n \"connectors\": [\n {\n \"id\": 2,\n \"name\": \"connector_name_target\",\n \"type\": \"HIVE\",\n \"version\": \"1.2\",\n \"predicates\": [\n {\n \"id\": 2,\n \"type\": \ "file.exist\",\n \"config\": {\n \"root.path\": \"hdfs:///griffin/demo_src\",\n \"path\": \"/dt=#YYYYMMdd#/hour=#HH#/_DONE\"\n }\n }\n ],\n \"data.unit\": \"1h\",\n \"config\": {\n \"database\": \"default\",\n \"table.name\": \"demo_src\",\n \"where\": \"dt=#YYYYMMdd# AND hour=#HH#\"\n }\n }\n ]\n }\n ],\n \"evaluate.rule\": {\n \"id\": 1,\n \"rules\": [\n {\n \"id\": 1,\n \"rule\": \"source.desc=target.desc\",\n \"name\": \"rule_name\",\n \"description\": \"Total count\",\n \"dsl.type\": \"griffin-dsl\",\n \"dq.type\": \"accuracy\",\n \"details\": {}\n }\n ]\n },\n \"measure.type\": \"griffin\"\n }", - "method": "PUT", - "dataMode": "raw" - } + "name": "Get griffin version example", + "id": "b5ad0bff-6306-6b99-614e-e33d46ce7a86", + "request": "89c14d57-74a2-f5c9-96fd-4d9d0ff68e04", + "owner": "2830994", + "requestObject": "{\"url\":\"{{BASE_PATH}}/api/v1/version\",\"pathVariables\":{},\"pathVariableData\":[],\"queryParams\":[],\"headerData\":[],\"headers\":\"\",\"data\":null,\"method\":\"GET\",\"dataMode\":\"params\"}" } ], - "rawModeData": "{\n \"id\": 1,\n \"name\": \"measureName_edit\",\n \"description\": \"measure description\",\n \"organization\": \"orgName\",\n \"owner\": \"test\",\n \"deleted\": false,\n \"dq.type\": \"accuracy\",\n \"process.type\": \"batch\",\n \"data.sources\": [\n {\n \"id\": 1,\n \"name\": \"source\",\n \"connectors\": [\n {\n \"id\": 1,\n \"name\": \"connector_name_source\",\n \"type\": \"HIVE\",\n \"version\": \"1.2\",\n \"predicates\": [\n {\n \"id\": 1,\n \"type\": \"file.exist\",\n \"config\": {\n \"root.path\": \"hdfs:///griffin/demo_src\",\n \"path\": \"/dt=#YYYYMMdd#/hour=#HH#/_DONE\"\n }\n }\n ],\n \"data.unit\": \"1h\",\n \"config\": {\n \"database\": \"default\",\n \"table.name\": \"demo_src\",\n \"where\": \"dt=#YYYYMMdd# AND hour=#HH#\"\n }\n }\n ]\n },\n {\n \"id\": 2,\n \"name\": \"target\",\n \"connectors\": [\n {\n \"id\": 2,\n \"name\": \"connector_name_target\",\n \"type\": \"HIVE\",\n \"version\": \"1.2\",\n \"predicates\": [\n {\n \"id\": 2,\n \"type\ ": \"file.exist\",\n \"config\": {\n \"root.path\": \"hdfs:///griffin/demo_src\",\n \"path\": \"/dt=#YYYYMMdd#/hour=#HH#/_DONE\"\n }\n }\n ],\n \"data.unit\": \"1h\",\n \"config\": {\n \"database\": \"default\",\n \"table.name\": \"demo_src\",\n \"where\": \"dt=#YYYYMMdd# AND hour=#HH#\"\n }\n }\n ]\n }\n ],\n \"evaluate.rule\": {\n \"id\": 1,\n \"rules\": [\n {\n \"id\": 1,\n \"rule\": \"source.desc=target.desc\",\n \"name\": \"rule_name\",\n \"description\": \"Total count\",\n \"dsl.type\": \"griffin-dsl\",\n \"dq.type\": \"accuracy\",\n \"details\": {}\n }\n ]\n },\n \"measure.type\": \"griffin\"\n }" + "collection_id": "c999a5d1-4ca3-e246-dd4f-6464e0be085f", + "isFromCollection": true, + "folder": "9cab795a-6c51-01da-5e13-f5abf5793a73", + "auth": null, + "currentHelper": null, + "helperAttributes": null }, { - "id": "2bfc82ab-ec97-ee89-d6b4-db5ffefce28b", + "id": "2e76c537-40a2-2d85-acb3-2f39a0b5ec98", "headers": "", "headerData": [], - "url": "{{BASE_PATH}}/api/v1/jobs/:id", - "queryParams": [], - "preRequestScript": null, - "pathVariables": { - "id": "3" - }, - "pathVariableData": [ + "url": "{{BASE_PATH}}/api/v1/metadata/hive/tables?db=default", + "queryParams": [ { - "key": "id", - "value": "3" + "key": "db", + "value": "default", + "equals": true, + "description": "", + "enabled": true } ], - "method": "DELETE", + "pathVariables": {}, + "pathVariableData": [], + "method": "GET", "data": null, "dataMode": "params", - "tests": null, - "currentHelper": "normal", - "helperAttributes": {}, - "time": 1515389245150, - "name": "Delete job by id", - "description": "`DELETE /api/v1/jobs/{id}`\n#### Path Variable\n- id -`required` `Long` job id\n\n#### Response Body Sample\n```\n{\n \"code\": 206,\n \"description\": \"Delete Job Succeed\"\n}\n\n```\nIt may return failed messages.Such as,\n```\n{\n \"code\": 406,\n \"description\": \"Delete Job Failed\"\n}\n```\nThe reason for failure may be that job id does not exist.", - "collectionId": "a743e1b9-583f-6bd7-e2ae-f03a1f807c63", + "version": 2, + "time": 1508997728908, + "name": "Get tables metadata", + "description": "`GET /api/v1/metadata/hive/tables`\n#### Request Parameter\nname | description | typ | example value\n--- | --- | --- | ---\ndb | hive database name | String | default", + "collectionId": "c999a5d1-4ca3-e246-dd4f-6464e0be085f", "responses": [ { "status": "", "responseCode": { "code": 200, - "name": "OK", - "detail": "Standard response for successful HTTP requests. The actual response will depend on the request method used. In a GET request, the response will contain an entity corresponding to the requested resource. In a POST request the response will contain an entity describing or containing the result of the action." + "name": "OK" }, - "time": 42, + "time": 28, "headers": [ { "name": "access-control-allow-headers", @@ -539,7 +466,7 @@ { "name": "date", "key": "date", - "value": "Wed, 10 Jan 2018 06:17:35 GMT", + "value": "Wed, 25 Oct 2017 05:50:07 GMT", "description": "The date and time that the message was sent" }, { @@ -551,7 +478,7 @@ ], "cookies": [], "mime": "", - "text": "{\n \"code\": 405,\n \"description\": \"Delete Job Succeed\"\n}", + "text": "[{\"tableName\":\"demo_src\",\"dbName\":\"default\",\"owner\":\"root\",\"createTime\":1507861756,\"lastAccessTime\":0,\"retention\":0,\"sd\":{\"cols\":[{\"name\":\"id\",\"type\":\"bigint\",\"comment\":null,\"setName\":true,\"setComment\":false,\"setType\":true},{\"name\":\"age\",\"type\":\"int\",\"comment\":null,\"setName\":true,\"setComment\":false,\"setType\":true},{\"name\":\"desc\",\"type\":\"string\",\"comment\":null,\"setName\":true,\"setComment\":false,\"setType\":true}],\"location\":\"hdfs://griffin:9000/griffin/data/batch/demo_src\",\"inputFormat\":\"org.apache.hadoop.mapred.TextInputFormat\",\"outputFormat\":\"org.apache.hadoop.hive.ql.io.HiveIgnoreKeyTextOutputFormat\",\"compressed\":false,\"numBuckets\":-1,\"serdeInfo\":{\"name\":null,\"serializationLib\":\"org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe\",\"parameters\":{\"field.delim\":\"|\",\"serialization.format\":\"|\"},\"setParameters\":true,\"parametersSize\":2,\"setName\":false,\"setSerialization Lib\":true},\"bucketCols\":[],\"sortCols\":[],\"parameters\":{},\"skewedInfo\":{\"skewedColNames\":[],\"skewedColValues\":[],\"skewedColValueLocationMaps\":{},\"skewedColValueLocationMapsSize\":0,\"skewedColNamesIterator\":[],\"setSkewedColValueLocationMaps\":true,\"skewedColValuesIterator\":[],\"skewedColNamesSize\":0,\"skewedColValuesSize\":0,\"setSkewedColValues\":true,\"setSkewedColNames\":true},\"storedAsSubDirectories\":false,\"colsSize\":3,\"setParameters\":true,\"parametersSize\":0,\"bucketColsSize\":0,\"setOutputFormat\":true,\"bucketColsIterator\":[],\"sortColsIterator\":[],\"setStoredAsSubDirectories\":true,\"sortColsSize\":0,\"setInputFormat\":true,\"setLocation\":true,\"setBucketCols\":true,\"setCols\":true,\"setSortCols\":true,\"setCompressed\":true,\"colsIterator\":[{\"name\":\"id\",\"type\":\"bigint\",\"comment\":null,\"setName\":true,\"setComment\":false,\"setType\":true},{\"name\":\"age\",\"type\":\"int\",\"comment\":null,\"setName\":true,\"setComment\":false,\"set Type\":true},{\"name\":\"desc\",\"type\":\"string\",\"comment\":null,\"setName\":true,\"setComment\":false,\"setType\":true}],\"setNumBuckets\":true,\"setSerdeInfo\":true,\"setSkewedInfo\":true},\"partitionKeys\":[],\"parameters\":{\"totalSize\":\"0\",\"EXTERNAL\":\"TRUE\",\"COLUMN_STATS_ACCURATE\":\"true\",\"numFiles\":\"0\",\"transient_lastDdlTime\":\"1508897403\"},\"viewOriginalText\":null,\"viewExpandedText\":null,\"tableType\":\"EXTERNAL_TABLE\",\"privileges\":null,\"temporary\":false,\"setSd\":true,\"setOwner\":true,\"setRetention\":true,\"setTableType\":true,\"setParameters\":true,\"setPrivileges\":false,\"setTableName\":true,\"setDbName\":true,\"setCreateTime\":true,\"setTemporary\":false,\"partitionKeysIterator\":[],\"partitionKeysSize\":0,\"parametersSize\":5,\"setViewOriginalText\":false,\"setPartitionKeys\":true,\"setLastAccessTime\":true,\"setViewExpandedText\":false},{\"tableName\":\"demo_tgt\",\"dbName\":\"default\",\"owner\":\"root\",\"createTime\":1507861756,\"lastA ccessTime\":0,\"retention\":0,\"sd\":{\"cols\":[{\"name\":\"id\",\"type\":\"bigint\",\"comment\":null,\"setName\":true,\"setComment\":false,\"setType\":true},{\"name\":\"age\",\"type\":\"int\",\"comment\":null,\"setName\":true,\"setComment\":false,\"setType\":true},{\"name\":\"desc\",\"type\":\"string\",\"comment\":null,\"setName\":true,\"setComment\":false,\"setType\":true}],\"location\":\"hdfs://griffin:9000/griffin/data/batch/demo_tgt\",\"inputFormat\":\"org.apache.hadoop.mapred.TextInputFormat\",\"outputFormat\":\"org.apache.hadoop.hive.ql.io.HiveIgnoreKeyTextOutputFormat\",\"compressed\":false,\"numBuckets\":-1,\"serdeInfo\":{\"name\":null,\"serializationLib\":\"org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe\",\"parameters\":{\"field.delim\":\"|\",\"serialization.format\":\"|\"},\"setParameters\":true,\"parametersSize\":2,\"setName\":false,\"setSerializationLib\":true},\"bucketCols\":[],\"sortCols\":[],\"parameters\":{},\"skewedInfo\":{\"skewedColNames\":[],\"skewedColValue s\":[],\"skewedColValueLocationMaps\":{},\"skewedColValueLocationMapsSize\":0,\"skewedColNamesIterator\":[],\"setSkewedColValueLocationMaps\":true,\"skewedColValuesIterator\":[],\"skewedColNamesSize\":0,\"skewedColValuesSize\":0,\"setSkewedColValues\":true,\"setSkewedColNames\":true},\"storedAsSubDirectories\":false,\"colsSize\":3,\"setParameters\":true,\"parametersSize\":0,\"bucketColsSize\":0,\"setOutputFormat\":true,\"bucketColsIterator\":[],\"sortColsIterator\":[],\"setStoredAsSubDirectories\":true,\"sortColsSize\":0,\"setInputFormat\":true,\"setLocation\":true,\"setBucketCols\":true,\"setCols\":true,\"setSortCols\":true,\"setCompressed\":true,\"colsIterator\":[{\"name\":\"id\",\"type\":\"bigint\",\"comment\":null,\"setName\":true,\"setComment\":false,\"setType\":true},{\"name\":\"age\",\"type\":\"int\",\"comment\":null,\"setName\":true,\"setComment\":false,\"setType\":true},{\"name\":\"desc\",\"type\":\"string\",\"comment\":null,\"setName\":true,\"setComment\":false,\"setType\" :true}],\"setNumBuckets\":true,\"setSerdeInfo\":true,\"setSkewedInfo\":true},\"partitionKeys\":[],\"parameters\":{\"totalSize\":\"0\",\"EXTERNAL\":\"TRUE\",\"COLUMN_STATS_ACCURATE\":\"true\",\"numFiles\":\"0\",\"transient_lastDdlTime\":\"1508897404\"},\"viewOriginalText\":null,\"viewExpandedText\":null,\"tableType\":\"EXTERNAL_TABLE\",\"privileges\":null,\"temporary\":false,\"setSd\":true,\"setOwner\":true,\"setRetention\":true,\"setTableType\":true,\"setParameters\":true,\"setPrivileges\":false,\"setTableName\":true,\"setDbName\":true,\"setCreateTime\":true,\"setTemporary\":false,\"partitionKeysIterator\":[],\"partitionKeysSize\":0,\"parametersSize\":5,\"setViewOriginalText\":false,\"setPartitionKeys\":true,\"setLastAccessTime\":true,\"setViewExpandedText\":false}]", "language": "json", "rawDataType": "text", "previewType": "text", @@ -560,50 +487,39 @@ "write": true, "empty": false, "failed": false, - "name": "Delete job by id example", - "id": "24c5f527-5e24-0272-3e0b-02789b9b25c0", - "request": { - "url": "{{BASE_PATH}}/api/v1/jobs/:id", - "pathVariables": { - "id": "1" - }, - "pathVariableData": [ - { - "key": "id", - "value": "1" - } - ], - "queryParams": [], - "headerData": [], - "headers": "", - "data": null, - "method": "DELETE", - "dataMode": "params" - } + "id": "5b83fd03-ede8-88d1-edc2-930a11f6beab", + "name": "Get tables metadata example", + "isSample": true, + "scrollToResult": false, + "runTests": false, + "request": "69bec869-3ce7-c507-8c40-a6fab234a957", + "owner": "2830994", + "requestObject": "{\"url\":\"{{BASE_PATH}}/api/v1/metadata/hive/tables?db=default\",\"pathVariables\":{},\"pathVariableData\":[],\"queryParams\":[{\"key\":\"db\",\"value\":\"default\",\"equals\":true,\"description\":\"\",\"enabled\":true}],\"headerData\":[],\"headers\":\"\",\"data\":null,\"method\":\"GET\",\"dataMode\":\"params\"}" } ], - "collection_id": "a743e1b9-583f-6bd7-e2ae-f03a1f807c63", - "folder": "40702c96-d08c-fd56-add4-5d26598e539e" + "collection_id": "c999a5d1-4ca3-e246-dd4f-6464e0be085f", + "folder": "83ca6edc-27b6-8b6c-a84c-527ed84397fa", + "auth": null, + "currentHelper": null, + "helperAttributes": null }, { - "id": "2d90ae20-5f65-df06-b533-e7f3e9ea3b50", + "id": "303cab65-5daa-a9cc-b080-9e3786cd0aab", "headers": "", "headerData": [], - "url": "{{BASE_PATH}}/api/v1/metadata/hive/dbs", + "url": "{{BASE_PATH}}/api/v1/measures", + "folder": "90bf25ee-3a44-f5a6-9862-415ada03390f", "queryParams": [], - "preRequestScript": null, "pathVariables": {}, "pathVariableData": [], "method": "GET", "data": null, "dataMode": "params", - "tests": null, - "currentHelper": "normal", - "helperAttributes": "{}", - "time": 1508997670920, - "name": "Get database names", - "description": "`GET /api/v1/metadata/hive/dbs`\n \n #### Get all database names", - "collectionId": "a743e1b9-583f-6bd7-e2ae-f03a1f807c63", + "version": 2, + "time": 1516340119702, + "name": "Get measures", + "description": "`GET /api/v1/measures`", + "collectionId": "c999a5d1-4ca3-e246-dd4f-6464e0be085f", "responses": [ { "status": "", @@ -611,7 +527,7 @@ "code": 200, "name": "OK" }, - "time": 225, + "time": 89, "headers": [ { "name": "access-control-allow-headers", @@ -646,7 +562,7 @@ { "name": "date", "key": "date", - "value": "Wed, 25 Oct 2017 05:12:36 GMT", + "value": "Thu, 26 Oct 2017 02:42:35 GMT", "description": "The date and time that the message was sent" }, { @@ -658,7 +574,7 @@ ], "cookies": [], "mime": "", - "text": "[\"default\"]", + "text": "[\n {\n \"id\": 1,\n \"name\": \"measureName\",\n \"description\": \"measure description\",\n \"organization\": \"orgName\",\n \"owner\": \"test\",\n \"deleted\": false,\n \"dq.type\": \"accuracy\",\n \"process.type\": \"batch\",\n \"data.sources\": [\n {\n \"id\": 1,\n \"name\": \"source\",\n \"connectors\": [\n {\n \"id\": 1,\n \"name\": \"connector_name_source\",\n \"type\": \"HIVE\",\n \"version\": \"1.2\",\n \"predicates\": [\n {\n \"id\": 1,\n \"type\": \"file.exist\",\n \"config\": {\n \"root.path\": \"hdfs:///griffin/demo_src\",\n \"path\": \"/dt=#YYYYMMdd#/hour=#HH#/_DONE\"\n }\n }\n ],\n \"data.unit\": \"1h\",\n \"config\": {\n \"database\": \"default\",\n \"table.name\": \"demo_src\",\n \"where\": \"dt=#YYYYMMdd# AND hour=#HH#\"\n }\n }\n ]\n },\n {\n \"id\": 2,\n \"name\": \"target\",\n \"connectors\": [\n {\n \"id\": 2,\n \"name\": \"connector_name_target\",\n \"type\": \"HIVE\",\n \"version\": \"1.2\",\n \"predicates\": [\n {\n \"id\": 2,\n \"type\": \"file.exist\",\n \"config\": {\n \"root.path\": \"hdfs:///griffin/demo_src\",\n \"path\": \"/dt=#YYYYMMdd#/hour=#HH#/_DONE\"\n }\n }\n ],\n \"data.unit\": \"1h\",\n \"config\": {\n \"database\": \"default\",\n \"table.name\": \"demo_src\",\n \"where\": \"dt=#YYYYMMdd# AND hour=#HH#\"\n }\n }\n ]\n }\n ],\n \"evaluate.rule\": {\n \"id\": 1,\n \"rules\": [\n {\n \"id\": 1,\n \"rule\": \"source.desc=target.desc\",\n \"name\": \"rule_name\",\n \"description\": \"Total count\",\n \"dsl.type\": \"griffin-dsl\",\n \"dq.type\": \"accuracy\",\n \"details\": {}\n }\n ]\n },\n \"measure.type\": \"griffin\"\n },\n {\n \"id\": 2,\n \"name\": \"external_name\",\n \"description\": \" test measure\",\n \"organization\": \"orgName\",\n \"owner\": \"test\",\n \"deleted\": false,\n \"metricName\": \"metricName\",\n \"measure.type\": \"external\"\n }\n]", "language": "json", "rawDataType": "text", "previewType": "text", @@ -667,156 +583,183 @@ "write": true, "empty": false, "failed": false, - "id": "52f80f82-5894-37bb-1d2e-84d0c5975991", - "name": "Get db names example", + "id": "7100976c-4229-efbc-b835-1799decac706", + "name": "Get measures example", "isSample": true, "scrollToResult": false, "runTests": false, - "request": "5985157f-88de-dd0c-70c2-add0f6b7d9f8", - "owner": "503523", - "requestObject": "{\"url\":\"{{BASE_PATH}}/api/v1/metadata/hive/dbs\",\"pathVariables\":{},\"pathVariableData\":[],\"queryParams\":[],\"headerData\":[],\"headers\":\"\",\"data\":null,\"method\":\"GET\",\"dataMode\":\"params\"}" + "request": { + "url": "{{BASE_PATH}}/api/v1/measures", + "pathVariables": {}, + "pathVariableData": [], + "queryParams": [], + "headerData": [], + "headers": "", + "data": null, + "method": "GET", + "dataMode": "params" + }, + "owner": "2830994" } ], - "collection_id": "a743e1b9-583f-6bd7-e2ae-f03a1f807c63", - "folder": "7ae8e04f-c5cb-aeab-9af3-65cb3bf87b1f" + "auth": null, + "collection_id": "c999a5d1-4ca3-e246-dd4f-6464e0be085f", + "currentHelper": null, + "helperAttributes": null }, { - "id": "2ebbf1cd-c78a-861e-6382-4a4d9dfba4be", - "headers": "Content-Type: application/json\n", - "headerData": [ + "id": "34632a9a-f66c-72a3-91b8-6956489d7786", + "headers": "", + "headerData": [], + "url": "{{BASE_PATH}}/api/v1/metrics/values?metricName=metricName", + "folder": "48b99278-ba7b-eee0-10a5-91de99619dd8", + "queryParams": [ { - "key": "Content-Type", - "value": "application/json", + "key": "metricName", + "value": "metricName", + "equals": true, "description": "", "enabled": true } ], - "url": "{{BASE_PATH}}/api/v1/measures", - "folder": "523a7f9f-1970-018e-9241-57caa3d6ea60", - "queryParams": [], - "preRequestScript": null, + "events": null, "pathVariables": {}, "pathVariableData": [], - "method": "POST", + "method": "DELETE", "data": [], "dataMode": "raw", - "tests": null, - "currentHelper": "normal", - "helperAttributes": {}, - "time": 1516341583244, - "name": "Add measure", - "description": "`POST /api/v1/measures`\n\n#### Request Header\nkey | value\n--- | ---\nContent-Type | application/json\n\n#### Request Body\n\nname | description | type\n--- | --- | --- \nmeasure | measure entity | Measure\n\nThere are two different measures that are griffin measure and external measure.\nIf you want to create an external measure,you can use following example json in request body.\n```\n{\n \"type\": \"external\",\n \"name\": \"external_name\",\n \"description\": \" test measure\",\n \"organization\": \"orgName\",\n \"owner\": \"test\",\n \"metricName\": \"metricName\"\n}\n```\nPostman gives a griffin measure example in request body and response body. \n#### Response Body Sample\n```\n{\n \"code\": 201,\n \"description\": \"Create Measure Succeed\"\n}\n```\n\nIt may return failed messages.Such as,\n\n```\n {\n \"code\": 410,\n \"description\": \"Create Measure Failed, duplicate records\"\n}\n\n```\n\nThe reason for failure may be that measu re name already exists.You can change measure name to make it unique.\n\n```\n {\n \"code\": 401,\n \"description\": \"Create Measure Failed\"\n}\n```\nThe reason for failure may be that connector names already exist or connector names are empty.", - "collectionId": "a743e1b9-583f-6bd7-e2ae-f03a1f807c63", + "version": 2, + "auth": null, + "time": 1517209675070, + "name": "Delete metric values by name", + "description": "`DELETE /api/v1/metrics/values`\n#### Request Parameters \n\nname | description | type | example value\n--- | --- | --- | ---\nmetricName | name of the metric values | String | metricName\n\n#### Response\nThe response body should have 'failures' field as empty if success, for example\n```\n{\n \"took\": 363,\n \"timed_out\": false,\n \"total\": 5,\n \"deleted\": 5,\n \"batches\": 1,\n \"version_conflicts\": 0,\n \"noops\": 0,\n \"retries\": {\n \"bulk\": 0,\n \"search\": 0\n },\n \"throttled_millis\": 0,\n \"requests_per_second\": -1,\n \"throttled_until_millis\": 0,\n \"failures\": []\n}\n```\nIt may return failed messages, for example\n```\n{\n \"timestamp\": 1517209504487,\n \"status\": 500,\n \"error\": \"Internal Server Error\",\n \"message\": \"Failed to delete metric values.\",\n \"exception\": \"java.net.ConnectException\",\n \"path\": \"/api/v1/metrics/values\"\n}\n```\nThere will be 'status' and 'error' fields in response if error happens, which correspond to HTTP status, and there may also be 'code' and 'message' fields, which will point out the cause. If an exception happens at server, there will be an 'exception' field, which is the name of exception.", + "collectionId": "c999a5d1-4ca3-e246-dd4f-6464e0be085f", "responses": [ { "status": "", "responseCode": { "code": 200, - "name": "OK" + "name": "OK", + "detail": "Standard response for successful HTTP requests. The actual response will depend on the request method used. In a GET request, the response will contain an entity corresponding to the requested resource. In a POST request the response will contain an entity describing or containing the result of the action." }, - "time": 629, + "time": 1014, "headers": [ { - "name": "access-control-allow-headers", - "key": "access-control-allow-headers", + "key": "Access-Control-Allow-Headers", "value": "X-PINGOTHER, Origin, X-Requested-With, Content-Type, Accept", + "name": "Access-Control-Allow-Headers", "description": "Used in response to a preflight request to indicate which HTTP headers can be used when making the actual request." }, { - "name": "access-control-allow-methods", - "key": "access-control-allow-methods", + "key": "Access-Control-Allow-Methods", "value": "POST, GET, OPTIONS, DELETE,PUT", + "name": "Access-Control-Allow-Methods", "description": "Specifies the method or methods allowed when accessing the resource. This is used in response to a preflight request." }, { - "name": "access-control-allow-origin", - "key": "access-control-allow-origin", + "key": "Access-Control-Allow-Origin", "value": "*", + "name": "Access-Control-Allow-Origin", "description": "Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource." }, { - "name": "access-control-max-age", - "key": "access-control-max-age", + "key": "Access-Control-Max-Age", "value": "3600", + "name": "Access-Control-Max-Age", "description": "Indicates how long the results of a preflight request can be cached in seconds." }, { - "name": "content-type", - "key": "content-type", - "value": "application/json;charset=UTF-8", + "key": "Content-Length", + "value": "217", + "name": "Content-Length", + "description": "The length of the response body in octets (8-bit bytes)" + }, + { + "key": "Content-Type", + "value": "application/json", + "name": "Content-Type", "description": "The mime type of this content" }, { - "name": "date", - "key": "date", - "value": "Tue, 24 Oct 2017 10:59:21 GMT", + "key": "Date", + "value": "Mon, 29 Jan 2018 07:06:30 GMT", + "name": "Date", "description": "The date and time that the message was sent" - }, + } + ], + "cookies": [ { - "name": "transfer-encoding", - "key": "transfer-encoding", - "value": "chunked", - "description": "The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity." + "domain": "localhost", + "expirationDate": 2147483647, + "httpOnly": true, + "name": "JSESSIONID", + "path": "/", + "secure": false, + "url": "http://localhost:8080";, + "value": "DC35BDC91FC450DE5D89D477E27FD19E" } ], - "cookies": [], "mime": "", - "text": "{\"code\":201,\"description\":\"Create Measure Succeed\"}", + "text": "{\"took\":363,\"timed_out\":false,\"total\":5,\"deleted\":5,\"batches\":1,\"version_conflicts\":0,\"noops\":0,\"retries\":{\"bulk\":0,\"search\":0},\"throttled_millis\":0,\"requests_per_second\":-1.0,\"throttled_until_millis\":0,\"failures\":[]}", "language": "json", - "rawDataType": "text", "previewType": "text", "searchResultScrolledTo": -1, "forceNoPretty": false, "write": true, "empty": false, "failed": false, - "id": "230f49b2-4c6c-2e0b-d2c5-8f4d127fff80", - "name": "Add measure example", - "isSample": true, - "scrollToResult": false, - "runTests": false, + "code": 200, + "responseSize": { + "body": 217, + "header": 324, + "total": 541 + }, + "mimeType": "text", + "fileName": "response.json", + "dataURI": "data:application/json;base64, eyJ0b29rIjozNjMsInRpbWVkX291dCI6ZmFsc2UsInRvdGFsIjo1LCJkZWxldGVkIjo1LCJiYXRjaGVzIjoxLCJ2ZXJzaW9uX2NvbmZsaWN0cyI6MCwibm9vcHMiOjAsInJldHJpZXMiOnsiYnVsayI6MCwic2VhcmNoIjowfSwidGhyb3R0bGVkX21pbGxpcyI6MCwicmVxdWVzdHNfcGVyX3NlY29uZCI6LTEuMCwidGhyb3R0bGVkX3VudGlsX21pbGxpcyI6MCwiZmFpbHVyZXMiOltdfQ==", + "name": "Delete metric values by name example", + "id": "8b3e405e-fa71-8bcd-2ab4-f603f7424a60", "request": { - "url": "{{BASE_PATH}}/api/v1/measures", + "url": "{{BASE_PATH}}/api/v1/metrics/values?metricName=metricName", "pathVariables": {}, "pathVariableData": [], - "queryParams": [], - "headerData": [ + "queryParams": [ { - "key": "Content-Type", - "value": "application/json", - "enabled": true, - "description": "" + "key": "metricName", + "value": "metricName", + "equals": true, + "description": "", + "enabled": true } ], - "headers": "Content-Type: application/json\n", - "data": "{\r\n \"name\":\"measureName\",\r\n\t\"measure.type\":\"griffin\",\r\n \"description\":\"measure description\",\r\n \"organization\":\"orgName\",\r\n\t\"owner\":\"test\",\r\n \"process.type\":\"batch\",\r\n\t\"dq.type\":\"accuracy\",\r\n \"evaluate.rule\":{\r\n \"rules\":[\r\n {\r\n\t\t\t\t\"name\":\"rule_name\",\r\n \"rule\":\"source.desc=target.desc\",\r\n\t\t\t\t\"description\":\"Total count\",\r\n \"dsl.type\":\"griffin-dsl\",\r\n \"dq.type\":\"accuracy\",\r\n \"details\":{}\r\n }\r\n ]\r\n },\r\n \r\n \"data.sources\":[\r\n {\r\n \"name\":\"source\",\r\n \"connectors\":[\r\n {\r\n\t\t\t\t\t\"name\":\"connector_name_source\",\r\n \"type\":\"HIVE\",\r\n \"version\":\"1.2\",\r\n\t\t\t\t\t\"data.unit\":\"1h\",\r\n \"config\":{\r\n \"database\":\"default\",\r\n \"table.name\":\"demo_src\",\r\n \"where\":\"dt=#YYYYMMdd# AND hour=#HH#\"\r\n },\r\n \"predicates\":[\r\n {\r\n \"type\":\"file.exist\",\r\n \"config\":{\r\n \"root.path\":\"hdfs:///griffin/demo_src\",\r\n \"path\":\"/dt=#YYYYMMdd#/hour=#HH#/_DONE\"\r\n }\r\n }\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"name\":\"target\",\r\n \"connectors\":[\r\n {\r\n\t\t\t\t\t\"name\":\"connector_name_target\",\r\n \"type\":\"HIVE\",\r\n \"version\":\"1.2\",\r\n\t\t\t\t\t\"data.unit\":\"1h\",\r\n \"config\":{\r\n \"database\":\"d efault\",\r\n \"table.name\":\"demo_src\",\r\n \"where\":\"dt=#YYYYMMdd# AND hour=#HH#\"\r\n },\r\n \"predicates\":[\r\n {\r\n \"type\":\"file.exist\",\r\n \"config\":{\r\n \"root.path\":\"hdfs:///griffin/demo_src\",\r\n \"path\":\"/dt=#YYYYMMdd#/hour=#HH#/_DONE\"\r\n }\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n ]\r\n}", - "method": "POST", + "headerData": [], + "headers": "", + "data": "", + "method": "DELETE", "dataMode": "raw" } } ], - "rawModeData": "{\r\n \"name\":\"measureName\",\r\n\t\"measure.type\":\"griffin\",\r\n \"description\":\"measure description\",\r\n \"organization\":\"orgName\",\r\n\t\"owner\":\"test\",\r\n \"process.type\":\"batch\",\r\n\t\"dq.type\":\"accuracy\",\r\n \"evaluate.rule\":{\r\n \"rules\":[\r\n {\r\n\t\t\t\t\"name\":\"rule_name\",\r\n \"rule\":\"source.desc=target.desc\",\r\n\t\t\t\t\"description\":\"Total count\",\r\n \"dsl.type\":\"griffin-dsl\",\r\n \"dq.type\":\"accuracy\",\r\n \"details\":{}\r\n }\r\n ]\r\n },\r\n \r\n \"data.sources\":[\r\n {\r\n \"name\":\"source\",\r\n \"connectors\":[\r\n {\r\n\t\t\t\t\t\"name\":\"connector_name_source\",\r\n \"type\":\"HIVE\",\r\n \"version\":\"1.2\",\r\n\t\t\t\t\t\"data.unit\":\"1h\",\r\n \"config\":{\r\n \"database\":\"default\",\r\n \"table.name\":\"demo_src\",\r\n \"where\":\"dt=#YYYYMMdd# AND hour=#HH#\"\r\n },\r\n \"predicates\":[\r\n {\r\n \"type\":\"file.exist\",\r\n \"config\":{\r\n \"root.path\":\"hdfs:///griffin/demo_src\",\r\n \"path\":\"/dt=#YYYYMMdd#/hour=#HH#/_DONE\"\r\n }\r\n }\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"name\":\"target\",\r\n \"connectors\":[\r\n {\r\n\t\t\t\t\t\"name\":\"connector_name_target\",\r\n \"type\":\"HIVE\",\r\n \"version\":\"1.2\",\r\n\t\t\t\t\t\"data.unit\":\"1h\",\r\n \"config\":{\r\n \"database\" :\"default\",\r\n \"table.name\":\"demo_src\",\r\n \"where\":\"dt=#YYYYMMdd# AND hour=#HH#\"\r\n },\r\n \"predicates\":[\r\n {\r\n \"type\":\"file.exist\",\r\n \"config\":{\r\n \"root.path\":\"hdfs:///griffin/demo_src\",\r\n \"path\":\"/dt=#YYYYMMdd#/hour=#HH#/_DONE\"\r\n }\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n ]\r\n}" + "currentHelper": null, + "helperAttributes": null, + "rawModeData": "" }, { - "id": "45aef93d-2bcf-4a1f-245a-29611d3d740e", + "id": "4bf76f4b-f639-d339-736a-e58ba36f0248", "headers": "", "headerData": [], - "url": "{{BASE_PATH}}/api/v1/org/measure/names", + "url": "{{BASE_PATH}}/api/v1/jobs/health", + "folder": "4e437aa6-f696-053e-8f1e-8b6a10c79015", "queryParams": [], - "preRequestScript": null, "pathVariables": {}, "pathVariableData": [], "method": "GET", "data": null, "dataMode": "params", - "version": 2, - "tests": null, - "currentHelper": "normal", - "helperAttributes": "{}", - "time": 1509332871323, - "name": "Get measure names group by org", - "description": "`GET /api/v1/orgWithMetricsName`", - "collectionId": "a743e1b9-583f-6bd7-e2ae-f03a1f807c63", + "time": 1515396046330, + "name": "Get job healthy statistics", + "description": "`GET /api/v1/jobs/health`\n\n#### Response Body Sample\n```\n{\n \"healthyJobCount\": 1,\n \"jobCount\": 2\n}\n```", + "collectionId": "c999a5d1-4ca3-e246-dd4f-6464e0be085f", "responses": [ { "status": "", @@ -824,7 +767,7 @@ "code": 200, "name": "OK" }, - "time": 5216, + "time": 391, "headers": [ { "name": "access-control-allow-headers", @@ -859,7 +802,7 @@ { "name": "date", "key": "date", - "value": "Mon, 30 Oct 2017 03:07:48 GMT", + "value": "Wed, 25 Oct 2017 08:10:53 GMT", "description": "The date and time that the message was sent" }, { @@ -871,7 +814,7 @@ ], "cookies": [], "mime": "", - "text": "{\"orgName\":[\"measureName_test_edit\",\"measureName_test_edit\",\"measureName1\"],\"test\":[\"measure1\"],\"ebay\":[\"new_measure_test_again\",\"third_measure\",\"fourth_measure\",\"fifth_measure\",\"third_measure\",\"measure\"]}", + "text": "{\n \"healthyJobCount\": 1,\n \"jobCount\": 2\n}", "language": "json", "rawDataType": "text", "previewType": "text", @@ -880,162 +823,176 @@ "write": true, "empty": false, "failed": false, - "name": "Get measure names group by org example", - "id": "35731fab-7671-5f16-6554-c9a34b6389c1", - "request": "8d77e0e0-62fd-242b-ea83-a7fc4829c778", - "owner": "503523", - "requestObject": "{\"url\":\"{{BASE_PATH}}/api/v1/org/measure/names\",\"pathVariables\":{},\"pathVariableData\":[],\"queryParams\":[],\"headerData\":[],\"headers\":\"\",\"data\":null,\"method\":\"GET\",\"dataMode\":\"params\"}" + "id": "b1b0dcbd-eb24-556f-bbe0-e292c88a76ba", + "name": "Get job healthy statistics example", + "isSample": true, + "scrollToResult": false, + "runTests": false, + "request": { + "url": "{{BASE_PATH}}/api/v1/jobs/health", + "pathVariables": {}, + "pathVariableData": [], + "queryParams": [], + "headerData": [], + "headers": "", + "data": null, + "method": "GET", + "dataMode": "params" + }, + "owner": "2830994" } ], - "isFromCollection": true, - "collection_id": "a743e1b9-583f-6bd7-e2ae-f03a1f807c63", - "folder": "04a4a902-f33b-bce5-06dc-4da56cae7c4f" + "collection_id": "c999a5d1-4ca3-e246-dd4f-6464e0be085f", + "auth": null, + "currentHelper": null, + "helperAttributes": null }, { - "id": "5767e1b2-a078-caec-34ae-b4366d66ba3d", - "headers": "Content-Type: application/json\n", - "headerData": [ + "id": "50d9ecef-c4ab-a026-52c1-36c9bd8fb472", + "headers": "", + "headerData": [], + "url": "{{BASE_PATH}}/api/v1/jobs?jobName=job_name", + "folder": "4e437aa6-f696-053e-8f1e-8b6a10c79015", + "queryParams": [ { - "key": "Content-Type", - "value": "application/json", + "key": "jobName", + "value": "job_name", + "equals": true, "description": "", "enabled": true } ], - "url": "{{BASE_PATH}}/api/v1/jobs", - "folder": "40702c96-d08c-fd56-add4-5d26598e539e", - "queryParams": [], - "preRequestScript": null, + "events": [], "pathVariables": {}, "pathVariableData": [], - "method": "POST", - "data": [], - "dataMode": "raw", - "tests": null, - "currentHelper": "normal", - "helperAttributes": {}, - "time": 1515396086639, - "name": "Add job", - "description": "`POST /api/v1/jobs`\n\n#### Request Header\nkey | value\n--- | ---\nContent-Type | application/json\n\n\n#### Request Body\nname | description | type \n--- | --- | ---\njobSchedule | custom class composed of job key parameters | JobSchedule \n\n\n#### Response Body Sample\n```\n{\n \"code\": 205,\n \"description\": \"Create Job Succeed\"\n}\n```\nIt may return failed messages.Such as,\n\n```\n{\n \"code\": 405,\n \"description\": \"Create Job Failed\"\n}\n```\n\nThere are several reasons to create job failure. \n- Measure id does not exist.\n- Job name already exits.\n- Param as.baselines aren't set or are all false.\n- Connector name doesn't exist in your measure.\n- The trigger key already exists.", - "collectionId": "a743e1b9-583f-6bd7-e2ae-f03a1f807c63", + "method": "DELETE", + "data": null, + "dataMode": "params", + "auth": null, + "time": 1517208694248, + "name": "Delete job by name", + "description": "`DELETE /api/v1/jobs`\n#### Request Parameters \n\nname | description | type | example value\n--- | --- | --- | ---\njobName | job name | String | job_name\n\n#### Response\nThe response body should be empty if no error happens, and the HTTP status is (204, \"No Content\").\nIt may return failed messages. For example\n```\n{\n \"timestamp\": 1517208660250,\n \"status\": 404,\n \"error\": \"Not Found\",\n \"code\": 40403,\n \"message\": \"Job name does not exist\",\n \"path\": \"/api/v1/jobs\"\n}\n```\nThere will be 'status' and 'error' fields in response if error happens, which correspond to HTTP status, and there may also be 'code' and 'message' fields, which will point out the cause. If an exception happens at server, there will be an 'exception' field, which is the name of exception.", + "collectionId": "c999a5d1-4ca3-e246-dd4f-6464e0be085f", "responses": [ { "status": "", "responseCode": { - "code": 200, - "name": "OK" + "code": 204, + "name": "No Content", + "detail": "The server successfully processed the request, but is not returning any content." }, - "time": 1772, + "time": 40, "headers": [ { - "name": "access-control-allow-headers", - "key": "access-control-allow-headers", + "key": "Access-Control-Allow-Headers", "value": "X-PINGOTHER, Origin, X-Requested-With, Content-Type, Accept", + "name": "Access-Control-Allow-Headers", "description": "Used in response to a preflight request to indicate which HTTP headers can be used when making the actual request." }, { - "name": "access-control-allow-methods", - "key": "access-control-allow-methods", + "key": "Access-Control-Allow-Methods", "value": "POST, GET, OPTIONS, DELETE,PUT", + "name": "Access-Control-Allow-Methods", "description": "Specifies the method or methods allowed when accessing the resource. This is used in response to a preflight request." }, { - "name": "access-control-allow-origin", - "key": "access-control-allow-origin", + "key": "Access-Control-Allow-Origin", "value": "*", + "name": "Access-Control-Allow-Origin", "description": "Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource." }, { - "name": "access-control-max-age", - "key": "access-control-max-age", + "key": "Access-Control-Max-Age", "value": "3600", + "name": "Access-Control-Max-Age", "description": "Indicates how long the results of a preflight request can be cached in seconds." }, { - "name": "content-type", - "key": "content-type", - "value": "application/json;charset=UTF-8", - "description": "The mime type of this content" - }, - { - "name": "date", - "key": "date", - "value": "Mon, 30 Oct 2017 03:11:43 GMT", + "key": "Date", + "value": "Mon, 29 Jan 2018 06:50:06 GMT", + "name": "Date", "description": "The date and time that the message was sent" - }, + } + ], + "cookies": [ { - "name": "transfer-encoding", - "key": "transfer-encoding", - "value": "chunked", - "description": "The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity." + "domain": "localhost", + "expirationDate": 2147483647, + "httpOnly": true, + "name": "JSESSIONID", + "path": "/", + "secure": false, + "url": "http://localhost:8080";, + "value": "DC35BDC91FC450DE5D89D477E27FD19E" } ], - "cookies": [], "mime": "", - "text": "{\"code\":205,\"description\":\"Create Job Succeed\"}", - "language": "json", - "rawDataType": "text", + "text": "", + "language": "plain", "previewType": "text", "searchResultScrolledTo": -1, "forceNoPretty": false, "write": true, "empty": false, "failed": false, - "id": "f0be7fe1-93b8-1342-e597-6512c60a54ea", - "name": "Add job example", - "isSample": true, - "scrollToResult": false, - "runTests": false, + "code": 204, + "responseSize": { + "body": 0, + "header": 279, + "total": 279 + }, + "mimeType": "text", + "fileName": "response.txt", + "dataURI": "data:text/plain;base64, ", + "name": "Delete job by name example", + "id": "2d39f622-9517-61eb-b792-52bae3e7cd74", "request": { - "url": "{{BASE_PATH}}/api/v1/jobs", + "url": "{{BASE_PATH}}/api/v1/jobs?jobName=job_name", "pathVariables": {}, "pathVariableData": [], - "queryParams": [], - "headerData": [ + "queryParams": [ { - "key": "Content-Type", - "value": "application/json", - "enabled": true, - "description": "" + "key": "jobName", + "value": "job_name", + "equals": true, + "description": "", + "enabled": true } ], - "headers": "Content-Type: application/json\n", - "data": "{\r\n \"measure.id\": 1,\r\n\t\"job.name\":\"job_name\",\r\n \"cron.expression\": \"0 0/4 * * * ?\",\r\n \"cron.time.zone\": \"GMT+8:00\",\r\n \"predicate.config\": {\r\n\t\t\"checkdonefile.schedule\":{\r\n\t\t\t\"interval\": \"5m\",\r\n\t\t\t\"repeat\": 12\r\n\t\t}\r\n },\r\n \"data.segments\": [\r\n {\r\n \"data.connector.name\": \"connector_name_source_test\",\r\n\t\t\t\"as.baseline\":true, \r\n \"segment.range\": {\r\n \"begin\": \"-1h\",\r\n \"length\": \"1h\"\r\n }\r\n },\r\n {\r\n \"data.connector.name\": \"connector_name_target_test\",\r\n \"segment.range\": {\r\n \"begin\": \"-1h\",\r\n \"length\": \"1h\"\r\n }\r\n }\r\n ]\r\n}", - "method": "POST", - "dataMode": "raw" - } - } + "headerData": [], + "headers": "", + "data": null, + "method": "DELETE", + "dataMode": "params" + } + } ], - "rawModeData": "{\r\n \"measure.id\": 2,\r\n\t\"job.name\":\"job_name\",\r\n \"cron.expression\": \"0 0/4 * * * ?\",\r\n \"cron.time.zone\": \"GMT+8:00\",\r\n \"predicate.config\": {\r\n\t\t\"checkdonefile.schedule\":{\r\n\t\t\t\"interval\": \"1m\",\r\n\t\t\t\"repeat\": 2\r\n\t\t}\r\n },\r\n \"data.segments\": [\r\n {\r\n \"data.connector.name\": \"connector_name_source_test\",\r\n\t\t\t\"as.baseline\":true, \r\n \"segment.range\": {\r\n \"begin\": \"-1h\",\r\n \"length\": \"1h\"\r\n }\r\n },\r\n {\r\n \"data.connector.name\": \"connector_name_target_test\",\r\n \"segment.range\": {\r\n \"begin\": \"-1h\",\r\n \"length\": \"1h\"\r\n }\r\n }\r\n ]\r\n}", - "collection_id": "a743e1b9-583f-6bd7-e2ae-f03a1f807c63" + "currentHelper": null, + "helperAttributes": null }, { - "id": "57cf1684-d812-5867-3c76-e285527a7c58", + "id": "733baba6-aa05-fe53-869e-ca6ea85ce389", "headers": "", "headerData": [], - "url": "{{BASE_PATH}}/api/v1/measures/owner/:owner", - "queryParams": [], - "preRequestScript": null, - "pathVariables": { - "owner": "test" - }, - "pathVariableData": [ + "url": "{{BASE_PATH}}/api/v1/metadata/hive/tables/names?db=default", + "queryParams": [ { - "key": "owner", - "value": "test" + "key": "db", + "value": "default", + "equals": true, + "description": "", + "enabled": true } ], + "pathVariables": {}, + "pathVariableData": [], "method": "GET", "data": null, "dataMode": "params", - "version": 2, - "tests": null, - "currentHelper": "normal", - "helperAttributes": "{}", - "time": 1508998395708, - "name": "Get measures by owner", - "description": "`GET /api/v1/measures/owner/{owner}`\n\n#### Path Variable\n- owner -`required` `String` owner name\n\n#### Request Sample\n\n`/api/v1/measures/owner/test`\n\n#### Response Body Sample\n```\n[\n {\n \"name\": \"demo-accu\",\n \"id\": \"2\"\n }\n]\n```", - "collectionId": "a743e1b9-583f-6bd7-e2ae-f03a1f807c63", + "time": 1508997683445, + "name": "Get table names", + "description": "`GET /api/v1/metadata/hive/tables/names`\n#### Request Parameter\nname | description | typ | example value\n--- | --- | --- | ---\ndb | hive database name | String | default", + "collectionId": "c999a5d1-4ca3-e246-dd4f-6464e0be085f", "responses": [ { "status": "", @@ -1043,7 +1000,7 @@ "code": 200, "name": "OK" }, - "time": 67, + "time": 226, "headers": [ { "name": "access-control-allow-headers", @@ -1078,7 +1035,7 @@ { "name": "date", "key": "date", - "value": "Thu, 26 Oct 2017 06:12:10 GMT", + "value": "Wed, 25 Oct 2017 05:11:54 GMT", "description": "The date and time that the message was sent" }, { @@ -1090,7 +1047,7 @@ ], "cookies": [], "mime": "", - "text": "[\n {\n \"measure.type\": \"griffin\",\n \"id\": 1,\n \"name\": \"measureName\",\n \"description\": \"measure description\",\n \"organization\": \"orgName\",\n \"owner\": \"test\",\n \"deleted\": false,\n \"dq.type\": \"accuracy\",\n \"process.type\": \"batch\",\n \"data.sources\": [\n {\n \"id\": 1,\n \"name\": \"source\",\n \"connectors\": [\n {\n \"id\": 1,\n \"name\": \"connector_name_source\",\n \"type\": \"HIVE\",\n \"version\": \"1.2\",\n \"predicates\": [\n {\n \"id\": 1,\n \"type\": \"file.exist\",\n \"config\": {\n \"root.path\": \"hdfs:///griffin/d emo_src\",\n \"path\": \"/dt=#YYYYMMdd#/hour=#HH#/_DONE\"\n }\n }\n ],\n \"data.unit\": \"1h\",\n \"config\": {\n \"database\": \"default\",\n \"table.name\": \"demo_src\",\n \"where\": \"dt=#YYYYMMdd# AND hour=#HH#\"\n }\n }\n ]\n },\n {\n \"id\": 2,\n \"name\": \"target\",\n \"connectors\": [\n {\n \"id\": 2,\n \"name\": \"connector_name_target\",\n \"type\": \"HIVE\",\n \"version\": \"1.2\",\n \"predicates\": [\n {\n \"id\": 2,\n \"type\": \"file.exist\",\n \"config\": {\n \"root.path\": \"hdfs:///griffin/demo_src\",\n \"path\": \"/dt=#YYYYMMdd#/hour=#HH#/_DONE\"\n }\n }\n ],\n \"data.unit\": \"1h\",\n \"config\": {\n \"database\": \"default\",\n \"table.name\": \"demo_src\",\n \"where\": \"dt=#YYYYMMdd# AND hour=#HH#\"\n }\n }\n ]\n }\n ],\n \"evaluate.rule\": {\n \"id\": 1,\n \"rules\": [\n {\n \"id\": 1,\n \"rule\": \"source.desc=target.desc\",\n \"name\": \"rule_name\",\n \"descri ption\": \"Total count\",\n \"dsl.type\": \"griffin-dsl\",\n \"dq.type\": \"accuracy\",\n \"details\": {}\n }\n ]\n }\n },\n {\n \"measure.type\": \"external\",\n \"id\": 2,\n \"name\": \"external_name\",\n \"description\": \" test measure\",\n \"organization\": \"orgName\",\n \"owner\": \"test\",\n \"deleted\": false,\n \"metricName\": \"metricName\"\n }\n]", + "text": "[\"demo_src\",\"demo_tgt\"]", "language": "json", "rawDataType": "text", "previewType": "text", @@ -1099,70 +1056,53 @@ "write": true, "empty": false, "failed": false, - "id": "146e3154-6a76-fb26-0de7-1572b363e1c8", - "name": "Get measures by owner example", + "id": "540caaf3-e9ec-3c0c-bbcc-eba18869b8fe", + "name": "Get table names example", "isSample": true, "scrollToResult": false, "runTests": false, - "request": { - "url": "{{BASE_PATH}}/api/v1/measures/owner/:owner", - "pathVariables": { - "owner": "test" - }, - "pathVariableData": [ - { - "key": "owner", - "value": "test" - } - ], - "queryParams": [], - "headerData": [], - "headers": "", - "data": null, - "method": "GET", - "dataMode": "params" - } + "request": "2d875b81-1a6e-6b3d-93a2-1cc225879369", + "owner": "2830994", + "requestObject": "{\"url\":\"{{BASE_PATH}}/api/v1/metadata/hive/tables/names?db=default\",\"pathVariables\":{},\"pathVariableData\":[],\"queryParams\":[{\"key\":\"db\",\"value\":\"default\",\"equals\":true,\"description\":\"\",\"enabled\":true}],\"headerData\":[],\"headers\":\"\",\"data\":null,\"method\":\"GET\",\"dataMode\":\"params\"}" } ], - "isFromCollection": true, - "collection_id": "a743e1b9-583f-6bd7-e2ae-f03a1f807c63", - "folder": "523a7f9f-1970-018e-9241-57caa3d6ea60" + "collection_id": "c999a5d1-4ca3-e246-dd4f-6464e0be085f", + "folder": "83ca6edc-27b6-8b6c-a84c-527ed84397fa", + "auth": null, + "currentHelper": null, + "helperAttributes": null }, { - "id": "619972f0-9f96-d4b5-3287-d2958f3a60c7", + "id": "7843c251-24ad-90c2-de8a-ad91641d1307", "headers": "", "headerData": [], - "url": "{{BASE_PATH}}/api/v1/org/:org", + "url": "{{BASE_PATH}}/api/v1/measures/owner/:owner", "queryParams": [], - "preRequestScript": null, "pathVariables": { - "org": "test" + "owner": "test" }, "pathVariableData": [ { - "key": "org", + "key": "owner", "value": "test" } ], "method": "GET", "data": null, "dataMode": "params", - "tests": null, - "currentHelper": "normal", - "helperAttributes": "{}", - "time": 1508998400445, - "name": "Get measure names by org", - "description": "`GET /api/v1/org/{org}`\n#### Path Variable\n- org - `required` `String` organization name.\n\n#### Request Sample\n`/api/v1/org/test`", - "collectionId": "a743e1b9-583f-6bd7-e2ae-f03a1f807c63", + "version": 2, + "time": 1508998395708, + "name": "Get measures by owner", + "description": "`GET /api/v1/measures/owner/{owner}`\n\n#### Path Variable\n- owner -`required` `String` owner name\n\n#### Request Sample\n\n`/api/v1/measures/owner/test`\n\n#### Response Body Sample\n```\n[\n {\n \"name\": \"demo-accu\",\n \"id\": \"2\"\n }\n]\n```", + "collectionId": "c999a5d1-4ca3-e246-dd4f-6464e0be085f", "responses": [ { "status": "", "responseCode": { "code": 200, - "name": "OK", - "detail": "Standard response for successful HTTP requests. The actual response will depend on the request method used. In a GET request, the response will contain an entity corresponding to the requested resource. In a POST request the response will contain an entity describing or containing the result of the action." + "name": "OK" }, - "time": 26, + "time": 67, "headers": [ { "name": "access-control-allow-headers", @@ -1197,7 +1137,7 @@ { "name": "date", "key": "date", - "value": "Thu, 26 Oct 2017 06:10:23 GMT", + "value": "Thu, 26 Oct 2017 06:12:10 GMT", "description": "The date and time that the message was sent" }, { @@ -1209,7 +1149,7 @@ ], "cookies": [], "mime": "", - "text": "[\"measure1\"]", + "text": "[\n {\n \"measure.type\": \"griffin\",\n \"id\": 1,\n \"name\": \"measureName\",\n \"description\": \"measure description\",\n \"organization\": \"orgName\",\n \"owner\": \"test\",\n \"deleted\": false,\n \"dq.type\": \"accuracy\",\n \"process.type\": \"batch\",\n \"data.sources\": [\n {\n \"id\": 1,\n \"name\": \"source\",\n \"connectors\": [\n {\n \"id\": 1,\n \"name\": \"connector_name_source\",\n \"type\": \"HIVE\",\n \"version\": \"1.2\",\n \"predicates\": [\n {\n \"id\": 1,\n \"type\": \"file.exist\",\n \"config\": {\n \"root.path\": \"hdfs:///griffin/d emo_src\",\n \"path\": \"/dt=#YYYYMMdd#/hour=#HH#/_DONE\"\n }\n }\n ],\n \"data.unit\": \"1h\",\n \"config\": {\n \"database\": \"default\",\n \"table.name\": \"demo_src\",\n \"where\": \"dt=#YYYYMMdd# AND hour=#HH#\"\n }\n }\n ]\n },\n {\n \"id\": 2,\n \"name\": \"target\",\n \"connectors\": [\n {\n \"id\": 2,\n \"name\": \"connector_name_target\",\n \"type\": \"HIVE\",\n \"version\": \"1.2\",\n \"predicates\": [\n {\n \"id\": 2,\n \"type\": \"file.exist\",\n \"config\": {\n \"root.path\": \"hdfs:///griffin/demo_src\",\n \"path\": \"/dt=#YYYYMMdd#/hour=#HH#/_DONE\"\n }\n }\n ],\n \"data.unit\": \"1h\",\n \"config\": {\n \"database\": \"default\",\n \"table.name\": \"demo_src\",\n \"where\": \"dt=#YYYYMMdd# AND hour=#HH#\"\n }\n }\n ]\n }\n ],\n \"evaluate.rule\": {\n \"id\": 1,\n \"rules\": [\n {\n \"id\": 1,\n \"rule\": \"source.desc=target.desc\",\n \"name\": \"rule_name\",\n \"descri ption\": \"Total count\",\n \"dsl.type\": \"griffin-dsl\",\n \"dq.type\": \"accuracy\",\n \"details\": {}\n }\n ]\n }\n },\n {\n \"measure.type\": \"external\",\n \"id\": 2,\n \"name\": \"external_name\",\n \"description\": \" test measure\",\n \"organization\": \"orgName\",\n \"owner\": \"test\",\n \"deleted\": false,\n \"metricName\": \"metricName\"\n }\n]", "language": "json", "rawDataType": "text", "previewType": "text", @@ -1218,140 +1158,176 @@ "write": true, "empty": false, "failed": false, - "name": "Get measure names by org example", - "id": "aa21397f-6fe9-6f87-3ed6-00e5e7052932", - "request": "9f6e5105-1aaf-22a0-f88a-dbc25277751d", - "owner": "503523", - "requestObject": "{\"url\":\"{{BASE_PATH}}/api/v1/org/:org\",\"pathVariables\":{\"org\":\"test\"},\"pathVariableData\":[{\"key\":\"org\",\"value\":\"test\"}],\"queryParams\":[],\"headerData\":[],\"headers\":\"\",\"data\":null,\"method\":\"GET\",\"dataMode\":\"params\"}" + "id": "8cfd0eb7-87bb-3431-2e52-11187d8c5071", + "name": "Get measures by owner example", + "isSample": true, + "scrollToResult": false, + "runTests": false, + "request": { + "url": "{{BASE_PATH}}/api/v1/measures/owner/:owner", + "pathVariables": { + "owner": "test" + }, + "pathVariableData": [ + { + "key": "owner", + "value": "test" + } + ], + "queryParams": [], + "headerData": [], + "headers": "", + "data": null, + "method": "GET", + "dataMode": "params" + }, + "owner": "2830994" } ], "isFromCollection": true, - "collection_id": "a743e1b9-583f-6bd7-e2ae-f03a1f807c63", - "folder": "04a4a902-f33b-bce5-06dc-4da56cae7c4f" + "collection_id": "c999a5d1-4ca3-e246-dd4f-6464e0be085f", + "folder": "90bf25ee-3a44-f5a6-9862-415ada03390f", + "auth": null, + "currentHelper": null, + "helperAttributes": null }, { - "id": "7daeb86c-dc01-fa99-9898-73ec4a6e7e57", + "id": "7bf89dbd-47e2-2c20-1631-fedccf836c8a", "headers": "", "headerData": [], - "url": "{{BASE_PATH}}/api/v1/metadata/hive/tables/names?db=default", - "queryParams": [ + "url": "{{BASE_PATH}}/api/v1/jobs/:id", + "folder": "4e437aa6-f696-053e-8f1e-8b6a10c79015", + "queryParams": [], + "events": [], + "pathVariables": { + "id": "2" + }, + "pathVariableData": [ { - "key": "db", - "value": "default", - "equals": true, - "description": "", - "enabled": true + "key": "id", + "value": "2" } ], - "preRequestScript": null, - "pathVariables": {}, - "pathVariableData": [], - "method": "GET", + "method": "DELETE", "data": null, "dataMode": "params", - "tests": null, - "currentHelper": "normal", - "helperAttributes": "{}", - "time": 1508997683445, - "name": "Get table names", - "description": "`GET /api/v1/metadata/hive/tables/names`\n#### Request Parameter\nname | description | typ | example value\n--- | --- | --- | ---\ndb | hive database name | String | default", - "collectionId": "a743e1b9-583f-6bd7-e2ae-f03a1f807c63", + "auth": null, + "time": 1517208818277, + "name": "Delete job by id", + "description": "`DELETE /api/v1/jobs/{id}`\n#### Path Variable\n- id -`required` `Long` job id\n\n#### Response\nThe response body should be empty if no error happens, and the HTTP status is (204, \"No Content\").\n\nIt may return failed messages. For example\n```\n{\n \"timestamp\": 1517208792108,\n \"status\": 404,\n \"error\": \"Not Found\",\n \"code\": 40402,\n \"message\": \"Job id does not exist\",\n \"path\": \"/api/v1/jobs/2\"\n}\n```\nThere will be 'status' and 'error' fields in response if error happens, which correspond to HTTP status, and there may also be 'code' and 'message' fields, which will point out the cause. If an exception happens at server, there will be an 'exception' field, which is the name of exception.", + "collectionId": "c999a5d1-4ca3-e246-dd4f-6464e0be085f", "responses": [ { "status": "", "responseCode": { - "code": 200, - "name": "OK" + "code": 204, + "name": "No Content", + "detail": "The server successfully processed the request, but is not returning any content." }, - "time": 226, + "time": 29, "headers": [ { - "name": "access-control-allow-headers", - "key": "access-control-allow-headers", + "key": "Access-Control-Allow-Headers", "value": "X-PINGOTHER, Origin, X-Requested-With, Content-Type, Accept", + "name": "Access-Control-Allow-Headers", "description": "Used in response to a preflight request to indicate which HTTP headers can be used when making the actual request." }, { - "name": "access-control-allow-methods", - "key": "access-control-allow-methods", + "key": "Access-Control-Allow-Methods", "value": "POST, GET, OPTIONS, DELETE,PUT", + "name": "Access-Control-Allow-Methods", "description": "Specifies the method or methods allowed when accessing the resource. This is used in response to a preflight request." }, { - "name": "access-control-allow-origin", - "key": "access-control-allow-origin", + "key": "Access-Control-Allow-Origin", "value": "*", +
<TRUNCATED>
