{ "info": { "_postman_id": "a92f1e68-7d09-435e-b80a-a57e7f276182", "name": "Basic Yellowfin REST API", "description": "This is the Mobile API for accessing Yellowfin goodness.\n\nContact Support:\n Name: API Support\n Email: support@example.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "name": "refresh-tokens", "item": [ { "name": "/", "item": [ { "name": "Get basic api info and related links", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.yellowfin.api-v1+json", "type": "text" }, { "key": "Authorization", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}", "host": [ "{{baseUrl}}" ] } }, "response": [] } ] }, { "name": "Gets a refresh token that can be used to fetch an access token or\nsignify login/logoff\n", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } }, { "listen": "test", "script": { "exec": [ "if (pm.response.code === 200) {", " var jsonData = pm.response.json();", " pm.collectionVariables.set(\"refreshtoken\", jsonData.securityToken);", "}", "" ], "type": "text/javascript" } } ], "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Authorization", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}", "type": "text", "description": "(Required) The accept header for requests to the API. Contains version information.", "disabled": true }, { "key": "Authorization", "value": "YELLOWFIN ts={{ts}}, nonce=random", "type": "text", "description": "(Required) Header Content-Type when creating a Refresh Token. This has to be\n'application/json'\n" }, { "key": "Content-Type", "value": "application/json", "type": "text", "description": "(Required) Authorization header when creating a refresh token. This header will\nhold authentication information using a custom scheme. This is what it\nshould look like for\n\n1. Login YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\nsignature=TleRkHWuqnzJ7H4Pt1Y==\n\n2. Onboarding YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - A security token\n\n* * In the Onboarding flow, this is the Onboarding Token\n\n* * In the Login flow, no token is required\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" }, { "key": "Accept", "value": "application/vnd.yellowfin.api-v1+json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"userName\": \"{{yfusername}}\",\n \"password\": \"{{yfpassword}}\",\n \"clientOrgRef\": \"{{yfclientOrgRef}}\"\n}" }, "url": { "raw": "{{baseUrl}}/refresh-tokens", "host": [ "{{baseUrl}}" ], "path": [ "refresh-tokens" ], "query": [ { "key": "singleSignOn", "value": "true", "disabled": true }, { "key": "noPassword", "value": "false", "disabled": true } ] } }, "response": [ { "name": "An error encountered by the server, returned as a model with an error\ncode and a description.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "Content-Type", "value": "schema type not provided", "description": "(Required) Header Content-Type when creating a Refresh Token. This has to be\n'application/json'\n" }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Authorization header when creating a refresh token. This header will\nhold authentication information using a custom scheme. This is what it\nshould look like for\n\n1. Login YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\nsignature=TleRkHWuqnzJ7H4Pt1Y==\n\n2. Onboarding YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - A security token\n\n* * In the Onboarding flow, this is the Onboarding Token\n\n* * In the Login flow, no token is required\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" }, { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "Content-Type", "value": "schema type not provided", "description": "(Required) Header Content-Type when creating a Refresh Token. This has to be\n'application/json'\n" }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Authorization header when creating a refresh token. This header will\nhold authentication information using a custom scheme. This is what it\nshould look like for\n\n1. Login YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\nsignature=TleRkHWuqnzJ7H4Pt1Y==\n\n2. Onboarding YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - A security token\n\n* * In the Onboarding flow, this is the Onboarding Token\n\n* * In the Login flow, no token is required\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" } ], "body": { "mode": "raw", "raw": "{\n \"userName\": \"john@yellowfin.com.au\",\n \"password\": \"1234\",\n \"clientOrgRef\": \"adsf\",\n \"deviceToken\": \"adsf\",\n \"pushNotificationService\": \"\",\n \"deviceInfo\": {\n \"device\": \"iphone10,6\",\n \"manufacturer\": \"Apple\",\n \"deviceName\": \"John Smith\",\n \"version\": \"12\",\n \"platform\": \"iOS\",\n \"idiom\": \"Phone\",\n \"deviceType\": \"Physical\"\n }\n}" }, "url": { "raw": "{{baseUrl}}/refresh-tokens", "host": [ "{{baseUrl}}" ], "path": [ "refresh-tokens" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "", "description": "The ETag." }, { "key": "Content-Language", "value": "", "description": "The preffered language of the user." }, { "key": "Content-Type", "value": "application/vnd.yellowfin.api-v1+json" } ], "cookie": [], "body": "{\n \"errorCode\": 401,\n \"reason\": \"INVALID_CREDENTIALS\",\n \"description\": \"Problem with the token or signature\"\n}" }, { "name": "A new refresh token that can be used to fetch an access token or signify\nlogin/logoff.\n", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"userName\": \"john@yellowfin.com.au\",\n \"password\": \"1234\",\n \"clientOrgRef\": \"adsf\",\n \"deviceToken\": \"adsf\",\n \"pushNotificationService\": \"\",\n \"deviceInfo\": {\n \"device\": \"iphone10,6\",\n \"manufacturer\": \"Apple\",\n \"deviceName\": \"John Smith\",\n \"version\": \"12\",\n \"platform\": \"iOS\",\n \"idiom\": \"Phone\",\n \"deviceType\": \"Physical\"\n }\n}" }, "url": { "raw": "{{baseUrl}}/refresh-tokens", "host": [ "{{baseUrl}}" ], "path": [ "refresh-tokens" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "", "description": "The ETag." }, { "key": "Content-Type", "value": "application/vnd.yellowfin.api-v1+json" } ], "cookie": [], "body": "{\n \"securityToken\": \"hHGOAlbR/9KjE3sOR0ZtQrMVqKkoR2oNL8/x54/uTgj81J87QUuZDEXCK+JPRRbTjhYFbEQUGN5ytpO9EnEtWkwGy1ot+843jewwIyZc9xDMEAi9caV15BeZIEbJfwQ/FmXlQZx6qCy999f+BDbywM0X/ntOi/0sAeFJ1q9GRGZR2ma1lcaeEe36yiy0teuTdpzMxa3yWNfjo7z1QOcvXxMOlDMJ/0N3S8cmFFT97mAyOVXs1w024eU0hh7KwTMFMbKPw60UfjLqmcfRNo5fBSXwILJ/QiQZhQy64oQkiBWfzd02bi4U0BdH4/Nmv+ZcQt13yScvZoz/zzLyBmYing==\\n\",\n \"_links\": {\n \"menu\": {\n \"href\": \"/api/menus/mobile-menu\",\n \"options\": [\n \"GET\"\n ]\n },\n \"self\": {\n \"href\": \"/api/refresh-tokens/23234223\",\n \"options\": [\n \"DELETE\"\n ]\n }\n },\n \"_embedded\": {\n \"accessToken\": {\n \"securityToken\": \"hHGOAlbR/9KjE3sOR0ZtQrMVqKkoR2oNL8/x54/uTgj81J87QUuZDEXCK+JPRRbTjhYFbEQUGN5ytpO9EnEtWkwGy1ot+843jewwIyZc9xDMEAi9caV15BeZIEbJfwQ/FmXlQZx6qCy999f+BDbywM0X/ntOi/0sAeFJ1q9GRGZR2ma1lcaeEe36yiy0teuTdpzMxa3yWNfjo7z1QOcvXxMOlDMJ/0N3S8cmFFT97mAyOVXs1w024eU0hh7KwTMFMbKPw60UfjLqmcfRNo5fBSXwILJ/QiQZhQy64oQkiBWfzd02bi4U0BdH4/Nmv+ZcQt13yScvZoz/zzLyBmYing==\\\\n\\n\",\n \"expiry\": 1200,\n \"_links\": {\n \"new\": {\n \"href\": \"/api/access-tokens\",\n \"options\": [\n \"POST\"\n ]\n }\n }\n },\n \"user\": {\n \"userId\": 12345,\n \"name\": \"Bob\",\n \"title\": \"Developer\",\n \"_links\": {\n \"self\": {\n \"href\": \"/api/users/12345\",\n \"options\": [\n \"GET\"\n ]\n }\n },\n \"_embedded\": {\n \"avatar\": {\n \"description\": \"A Picture of a Dog.\",\n \"_links\": {\n \"self\": {\n \"href\": \"/api/users/12345/avatar\",\n \"options\": [\n \"GET\"\n ]\n }\n }\n }\n }\n }\n }\n}" } ] }, { "name": "Deletes a refresh token (log off)", "request": { "auth": { "type": "noauth" }, "method": "DELETE", "header": [ { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" } ], "url": { "raw": "{{baseUrl}}/refresh-tokens/{{refreshtoken}}", "host": [ "{{baseUrl}}" ], "path": [ "refresh-tokens", "{{refreshtoken}}" ] } }, "response": [ { "name": "An error encountered by the server, returned as a model with an error\ncode and a description.\n", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" }, { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" } ], "url": { "raw": "{{baseUrl}}/refresh-tokens/:refreshTokenId", "host": [ "{{baseUrl}}" ], "path": [ "refresh-tokens", ":refreshTokenId" ], "variable": [ { "key": "refreshTokenId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "", "description": "The ETag." }, { "key": "Content-Language", "value": "", "description": "The preffered language of the user." }, { "key": "Content-Type", "value": "application/vnd.yellowfin.api-v1+json" } ], "cookie": [], "body": "{\n \"errorCode\": 401,\n \"reason\": \"INVALID_CREDENTIALS\",\n \"description\": \"Problem with the token or signature\"\n}" }, { "name": "Links when a refresh token is deleted", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/refresh-tokens/:refreshTokenId", "host": [ "{{baseUrl}}" ], "path": [ "refresh-tokens", ":refreshTokenId" ], "variable": [ { "key": "refreshTokenId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "", "description": "The ETag." }, { "key": "Content-Type", "value": "application/vnd.yellowfin.api-v1+json" } ], "cookie": [], "body": "{\n \"_links\": {\n \"login\": {\n \"href\": \"/api/refresh-tokens\",\n \"  options\": [\n \"POST\"\n ]\n }\n }\n}" } ] } ] }, { "name": "access-tokens", "item": [ { "name": "Gets an access token that can be used to access a resource", "event": [ { "listen": "test", "script": { "exec": [ "if (pm.response.code === 200) {", " var jsonData = pm.response.json();", " pm.collectionVariables.set(\"accesstoken\", jsonData.securityToken);", "}", "" ], "type": "text/javascript" } }, { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Accept", "value": "application/vnd.yellowfin.api-v1+json", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "Authorization", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{refreshtoken}}", "description": "(Required) Authorization header when creating an access token. This header will\nhold authentication information using a custom scheme. This is what it\nshould look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - A refresh token that was acquired before when the user was\nlogged in\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/access-tokens", "host": [ "{{baseUrl}}" ], "path": [ "access-tokens" ] } }, "response": [ { "name": "A new access token that can be used to access resources.", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/access-tokens", "host": [ "{{baseUrl}}" ], "path": [ "access-tokens" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "", "description": "The ETag." }, { "key": "Content-Type", "value": "application/vnd.yellowfin.api-v1+json" } ], "cookie": [], "body": "{\n \"securityToken\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJjbGllbnQiOiIxIiwicm9sZSI6IllGQURNSU4iLCJleHAiOjE1NTUzOTg4MTcsInRpIjoyMzQyMzQsImlhdCI6MTU1NTM5NzYxNywicGVyc29uIjoiNSJ9.nPcUTizWJM0uSFB5XO5E_UYI1HsaredjE5GRKM1FtPKmefcWlk23YtN8zCNXIFqyZS2Ah0bUDYYZvYwEyweFiQ\\n\",\n \"expiry\": 1200,\n \"_links\": {\n \"menu\": {\n \"href\": \"/api/menus/mobile-menu\",\n \"options\": [\n \"GET\"\n ]\n },\n \"new\": {\n \"href\": \"/api/access-tokens\",\n \"options\": [\n \"POST\"\n ]\n }\n }\n}" }, { "name": "An error encountered by the server, returned as a model with an error\ncode and a description.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Authorization header when creating an access token. This header will\nhold authentication information using a custom scheme. This is what it\nshould look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - A refresh token that was acquired before when the user was\nlogged in\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" }, { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Authorization header when creating an access token. This header will\nhold authentication information using a custom scheme. This is what it\nshould look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - A refresh token that was acquired before when the user was\nlogged in\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" } ], "url": { "raw": "{{baseUrl}}/access-tokens", "host": [ "{{baseUrl}}" ], "path": [ "access-tokens" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "", "description": "The ETag." }, { "key": "Content-Language", "value": "", "description": "The preffered language of the user." }, { "key": "Content-Type", "value": "application/vnd.yellowfin.api-v1+json" } ], "cookie": [], "body": "{\n \"errorCode\": 401,\n \"reason\": \"INVALID_CREDENTIALS\",\n \"description\": \"Problem with the token or signature\"\n}" } ] } ] }, { "name": "menus", "item": [ { "name": "Returns the links for a menu designed for mobile applications.", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." } ], "url": { "raw": "{{baseUrl}}/menus/mobile-menu", "host": [ "{{baseUrl}}" ], "path": [ "menus", "mobile-menu" ] } }, "response": [ { "name": "An error encountered by the server, returned as a model with an error\ncode and a description.\n", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." } ], "url": { "raw": "{{baseUrl}}/menus/mobile-menu", "host": [ "{{baseUrl}}" ], "path": [ "menus", "mobile-menu" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "", "description": "The ETag." }, { "key": "Content-Language", "value": "", "description": "The preffered language of the user." }, { "key": "Content-Type", "value": "application/vnd.yellowfin.api-v1+json" } ], "cookie": [], "body": "{\n \"errorCode\": 401,\n \"reason\": \"INVALID_CREDENTIALS\",\n \"description\": \"Problem with the token or signature\"\n}" }, { "name": "A menu object containing only _links and _embedded objects.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/menus/mobile-menu", "host": [ "{{baseUrl}}" ], "path": [ "menus", "mobile-menu" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "", "description": "The ETag." }, { "key": "Content-Language", "value": "", "description": "The preffered language of the user." }, { "key": "Content-Type", "value": "application/vnd.yellowfin.api-v1+json" } ], "cookie": [], "body": "{\n \"_links\": {\n \"self\": {\n \"href\": \"/api/menus/mobile-menu\",\n \"options\": [\n \"GET\"\n ]\n }\n },\n \"_embedded\": {\n \"user\": {\n \"userId\": 12345,\n \"name\": \"Bobbo\",\n \"email\": \"email@fake.com\",\n \"title\": \"CEO\",\n \"_links\": {\n \"self\": {\n \"href\": \"/api/users/12345\",\n \"options\": [\n \"GET\",\n \"PATCH\"\n ]\n }\n },\n \"_embedded\": {\n \"avatar\": {\n \"description\": \"A Picture of a Dog.\",\n \"_links\": {\n \"self\": {\n \"href\": \"/api/users/12345/avatar\",\n \"options\": [\n \"GET\"\n ]\n }\n }\n }\n }\n },\n \"items\": [\n {\n \"label\": \"Timeline\",\n \"key\": \"timeline\",\n \"_links\": {\n \"timeline\": {\n \"href\": \"/api/timeline\",\n \"options\": [\n \"GET\"\n ]\n }\n }\n },\n {\n \"label\": \"Signals\",\n \"key\": \"signals\",\n \"_links\": {\n \"signals\": {\n \"href\": \"/api/signals\",\n \"options\": [\n \"GET\"\n ]\n }\n }\n },\n {\n \"label\": \"Stories\",\n \"key\": \"stories\",\n \"_links\": {\n \"stories\": {\n \"href\": \"/api/stories\",\n \"options\": [\n \"GET\"\n ]\n }\n }\n },\n {\n \"label\": \"Streams\",\n \"key\": \"discussion-streams\",\n \"_links\": {\n \"streams\": {\n \"href\": \"/api/discussion-streams\",\n \"options\": [\n \"GET\"\n ]\n }\n }\n },\n {\n \"label\": \"People\",\n \"key\": \"users\",\n \"_links\": {\n \"people\": {\n \"href\": \"/api/users\",\n \"options\": [\n \"GET\"\n ]\n }\n }\n },\n {\n \"label\": \"Profile\",\n \"key\": \"user\",\n \"_links\": {\n \"profile\": {\n \"href\": \"api/user/12345\",\n \"options\": [\n \"GET\",\n \"PATCH\"\n ]\n }\n }\n },\n {\n \"label\": \"Logout\",\n \"_links\": {\n \"logout\": {\n \"href\": \"Not yet implemented\",\n \"options\": [\n \"POST\"\n ]\n }\n }\n }\n ]\n }\n}" } ] } ] }, { "name": "orgs", "item": [ { "name": "{ipOrg}", "item": [ { "name": "system-configs", "item": [ { "name": "{configCode}", "item": [ { "name": "Get a config value", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/vnd.yellowfin.api-v1+json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/orgs/:ipOrg/system-configs/:configCode", "host": [ "{{baseUrl}}" ], "path": [ "orgs", ":ipOrg", "system-configs", ":configCode" ], "variable": [ { "key": "ipOrg", "value": "1" }, { "key": "configCode", "value": "CLIENTORGS" } ] } }, "response": [] }, { "name": "Update a config value", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/vnd.yellowfin.api-v1+json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n\t\"configValue\": \"YES\"\n}" }, "url": { "raw": "{{baseUrl}}/orgs/:ipOrg/system-configs/:configCode?refreshCache=true", "host": [ "{{baseUrl}}" ], "path": [ "orgs", ":ipOrg", "system-configs", ":configCode" ], "query": [ { "key": "refreshCache", "value": "true" } ], "variable": [ { "key": "ipOrg", "value": "1" }, { "key": "configCode", "value": "CLIENTORGS" } ] } }, "response": [] } ] }, { "name": "Get a list of system configs for an org", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/vnd.yellowfin.api-v1+json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/orgs/:ipOrg/system-configs", "host": [ "{{baseUrl}}" ], "path": [ "orgs", ":ipOrg", "system-configs" ], "variable": [ { "key": "ipOrg", "value": "1" } ] } }, "response": [] } ] }, { "name": "custom-configs", "item": [ { "name": "{configCode}", "item": [ { "name": "Get a config value", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/vnd.yellowfin.api-v1+json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/orgs/:ipOrg/custom-configs/:configCode", "host": [ "{{baseUrl}}" ], "path": [ "orgs", ":ipOrg", "custom-configs", ":configCode" ], "variable": [ { "key": "ipOrg", "value": "" }, { "key": "configCode", "value": "" } ] } }, "response": [] }, { "name": "Update a config value", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/vnd.yellowfin.api-v1+json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n\t\"configValue\": \"asdfghjkl\"\n}" }, "url": { "raw": "{{baseUrl}}/orgs/:ipOrg/custom-configs/:configCode?refreshCache=true", "host": [ "{{baseUrl}}" ], "path": [ "orgs", ":ipOrg", "custom-configs", ":configCode" ], "query": [ { "key": "refreshCache", "value": "true" } ], "variable": [ { "key": "ipOrg", "value": "" }, { "key": "configCode", "value": "" } ] } }, "response": [] } ] }, { "name": "Get a list of custom configs for an org", "request": { "method": "GET", "header": [ { "key": "Authorization", "type": "text", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}" }, { "key": "Content-Type", "type": "text", "value": "application/json" }, { "key": "Accept", "type": "text", "value": "application/vnd.yellowfin.api-v1+json" } ], "url": { "raw": "{{baseUrl}}/orgs/:ipOrg/custom-configs", "host": [ "{{baseUrl}}" ], "path": [ "orgs", ":ipOrg", "custom-configs" ], "variable": [ { "key": "ipOrg", "value": "1" } ] } }, "response": [] } ] }, { "name": "user-access", "item": [ { "name": "(userId)", "item": [ { "name": "Remove a user's access to this org", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/vnd.yellowfin.api-v1+json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/orgs/:ipOrg/user-access/:userId", "host": [ "{{baseUrl}}" ], "path": [ "orgs", ":ipOrg", "user-access", ":userId" ], "variable": [ { "key": "ipOrg", "value": "13001" }, { "key": "userId", "value": "13002" } ] } }, "response": [] } ] }, { "name": "Get a list of all users who have login access to this org", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/vnd.yellowfin.api-v1+json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/orgs/:ipOrg/user-access", "host": [ "{{baseUrl}}" ], "path": [ "orgs", ":ipOrg", "user-access" ], "variable": [ { "key": "ipOrg", "value": "1" } ] } }, "response": [] }, { "name": "Give a user access to this org", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/vnd.yellowfin.api-v1+json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"userId\": 13002\r\n}" }, "url": { "raw": "{{baseUrl}}/orgs/:ipOrg/user-access", "host": [ "{{baseUrl}}" ], "path": [ "orgs", ":ipOrg", "user-access" ], "variable": [ { "key": "ipOrg", "value": "13001" } ] } }, "response": [] } ] }, { "name": "Get a single org", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "type": "text", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}" }, { "key": "Content-Type", "type": "text", "value": "application/json" }, { "key": "Accept", "type": "text", "value": "application/vnd.yellowfin.api-v1+json" } ], "url": { "raw": "{{baseUrl}}/orgs/:ipOrg", "host": [ "{{baseUrl}}" ], "path": [ "orgs", ":ipOrg" ], "variable": [ { "key": "ipOrg", "value": "1" } ] }, "description": "Request a list of all available organisations, must have required permissions to see any org other than the current one" }, "response": [] }, { "name": "Update an org", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "method": "PATCH", "header": [ { "key": "Authorization", "type": "text", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}" }, { "key": "Content-Type", "type": "text", "value": "application/json" }, { "key": "Accept", "type": "text", "value": "application/vnd.yellowfin.api-v1+json" } ], "body": { "mode": "raw", "raw": "{\n\t\"name\": \"CO5\",\n\t\"clientRefId\": \"CO5\",\n\t\"customStylePath\": \"co5\",\n\t\"defaultTimezone\": \"AUSTRALIA/SYDNEY\"\n}" }, "url": { "raw": "{{baseUrl}}/orgs/:ipOrg", "host": [ "{{baseUrl}}" ], "path": [ "orgs", ":ipOrg" ], "variable": [ { "key": "ipOrg", "value": "" } ] }, "description": "Request a list of all available organisations, must have required permissions to see any org other than the current one" }, "response": [] }, { "name": "Delete a client org", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "method": "DELETE", "header": [ { "key": "Authorization", "type": "text", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}" }, { "key": "Content-Type", "type": "text", "value": "application/json" }, { "key": "Accept", "type": "text", "value": "application/vnd.yellowfin.api-v1+json" } ], "url": { "raw": "{{baseUrl}}/orgs/:ipOrg", "host": [ "{{baseUrl}}" ], "path": [ "orgs", ":ipOrg" ], "variable": [ { "key": "ipOrg", "value": "13014" } ] }, "description": "Request a list of all available organisations, must have required permissions to see any org other than the current one" }, "response": [] } ] }, { "name": "Get a list of orgs", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/vnd.yellowfin.api-v1+json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/orgs", "host": [ "{{baseUrl}}" ], "path": [ "orgs" ] }, "description": "Request a list of all available organisations, must have required permissions to see any org other than the current one" }, "response": [] }, { "name": "Create a new client org", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "type": "text", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}" }, { "key": "Content-Type", "type": "text", "value": "application/json" }, { "key": "Accept", "type": "text", "value": "application/vnd.yellowfin.api-v1+json" } ], "body": { "mode": "raw", "raw": "{\n\t\"name\": \"CO5\",\n\t\"clientRefId\": \"CO5\",\n\t\"customStylePath\": \"co5\",\n\t\"defaultTimezone\": \"AUSTRALIA/SYDNEY\"\n}" }, "url": { "raw": "{{baseUrl}}/orgs", "host": [ "{{baseUrl}}" ], "path": [ "orgs" ] }, "description": "Request a list of all available organisations, must have required permissions to see any org other than the current one" }, "response": [] } ] }, { "name": "users", "item": [ { "name": "{user Id}", "item": [ { "name": "avatar", "item": [ { "name": "Get a users' avatar as an image model.", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" } ], "url": { "raw": "{{baseUrl}}/users/:userId/avatar?thumbSize=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":userId", "avatar" ], "query": [ { "key": "thumbSize", "value": "", "description": "An enumeration of predefined image sizes.\n\n* STRETCH - The image is stretched to the exact dimensions, which may\nalter the aspect ratio.\n\n* SCALE - The image is scaled to fit within the dimensions, while\nmaintaining the aspect ratio. Only one of (width, height) of the\nthumbnail image is guaranteed to match the ThumbnailSize dimensions.\n\n\n* SCALEFILL - The image is scaled to fit within the dimensions, while\nmaintaining the aspect ratio. The thumbnail is centered within the image\ncanvas, which will have the exact ThumbnailSize dimensions. Only one of\n(width, height) of the thumbnail image is guaranteed to fill the image\nbounds, the rest of the image will be transparent.\n\n\n* CROP - The image is scaled and cropped to fit within the exact\ndimensions, while maintaining the aspect ratio.\n\n\n* SCALEWIDTH_MAXHEIGHT - The image is scaled to the specified width. The\nheight is cropped to a specified maximum height if required.\n" } ], "variable": [ { "key": "userId", "value": "", "description": "(Required) The Id of the user." } ] } }, "response": [ { "name": "An error encountered by the server, returned as a model with an error\ncode and a description.\n", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" }, { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" } ], "url": { "raw": "{{baseUrl}}/users/:userId/avatar?thumbSize=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":userId", "avatar" ], "query": [ { "key": "thumbSize", "value": "" } ], "variable": [ { "key": "userId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "", "description": "The ETag." }, { "key": "Content-Language", "value": "", "description": "The preffered language of the user." }, { "key": "Content-Type", "value": "application/vnd.yellowfin.api-v1+json" } ], "cookie": [], "body": "{\n \"errorCode\": 401,\n \"reason\": \"INVALID_CREDENTIALS\",\n \"description\": \"Problem with the token or signature\"\n}" }, { "name": "An avatar of a user.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/users/:userId/avatar?thumbSize=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":userId", "avatar" ], "query": [ { "key": "thumbSize", "value": "" } ], "variable": [ { "key": "userId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "ETag", "value": "", "description": "The ETag." }, { "key": "Content-Language", "value": "", "description": "The preffered language of the user." }, { "key": "Content-Type", "value": "image/vnd.yellowfin.api-v1" } ], "cookie": [], "body": "A3 B8 37 F1" } ] }, { "name": "Update a users' avatar with a new image.", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" }, { "key": "Content-Type", "value": "multipart/form-data" } ], "body": { "mode": "formdata", "formdata": [ { "key": "avatar", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/users/:userId/avatar", "host": [ "{{baseUrl}}" ], "path": [ "users", ":userId", "avatar" ], "variable": [ { "key": "userId", "value": "", "description": "(Required) The Id of the user." } ] } }, "response": [ { "name": "An error encountered by the server, returned as a model with an error\ncode and a description.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" }, { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" } ], "body": { "mode": "formdata", "formdata": [ { "key": "avatar", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/users/:userId/avatar", "host": [ "{{baseUrl}}" ], "path": [ "users", ":userId", "avatar" ], "variable": [ { "key": "userId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "", "description": "The ETag." }, { "key": "Content-Language", "value": "", "description": "The preffered language of the user." }, { "key": "Content-Type", "value": "application/vnd.yellowfin.api-v1+json" } ], "cookie": [], "body": "{\n \"errorCode\": 401,\n \"reason\": \"INVALID_CREDENTIALS\",\n \"description\": \"Problem with the token or signature\"\n}" }, { "name": "Links to perform when a user's avatar is updated", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "avatar", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/users/:userId/avatar", "host": [ "{{baseUrl}}" ], "path": [ "users", ":userId", "avatar" ], "variable": [ { "key": "userId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "ETag", "value": "", "description": "The ETag." }, { "key": "Content-Language", "value": "", "description": "The preffered language of the user." }, { "key": "Content-Type", "value": "application/vnd.yellowfin.api-v1" } ], "cookie": [], "body": "" } ] } ] }, { "name": "followees", "item": [ { "name": "{another User Id}", "item": [ { "name": "UserId attempts to follow anotherUserId, pending the approval of\nanotherUserId.\n", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" } ], "url": { "raw": "{{baseUrl}}/users/:userId/followees/:anotherUserId?fields={}", "host": [ "{{baseUrl}}" ], "path": [ "users", ":userId", "followees", ":anotherUserId" ], "query": [ { "key": "fields", "value": "{}", "description": "The properties that should be returned in the requested model or list of\nmodels\n" } ], "variable": [ { "key": "userId", "value": "", "description": "(Required) The Id of the user." }, { "key": "anotherUserId", "value": "", "description": "(Required) The Id of another user." } ] } }, "response": [ { "name": "Links for performing operations on a follower.", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/users/:userId/followees/:anotherUserId?fields=[object Object]", "host": [ "{{baseUrl}}" ], "path": [ "users", ":userId", "followees", ":anotherUserId" ], "query": [ { "key": "fields", "value": "[object Object]" } ], "variable": [ { "key": "userId" }, { "key": "anotherUserId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "", "description": "The ETag." }, { "key": "Content-Language", "value": "", "description": "The preffered language of the user." }, { "key": "Content-Type", "value": "application/vnd.yellowfin.api-v1+json" } ], "cookie": [], "body": "{\n \"subjectUserId\": 12345,\n \"objectUserId\": 67890,\n \"userConnectionStatus\": \"CONNECTED\",\n \"_links\": {\n \"self\": {\n \"href\": \"/api/users/12345/followers/67890\",\n \"options\": [\n \"DELETE\"\n ]\n },\n \"menu\": {\n \"href\": \"/api/menus/mobile-menu\",\n \"options\": [\n \"GET\"\n ]\n },\n \"subjectUser\": {\n \"href\": \"/api/users/12345\",\n \"options\": [\n \"GET\"\n ]\n },\n \"objectUser\": {\n \"href\": \"/api/users/67890\",\n \"options\": [\n \"GET\"\n ]\n }\n }\n}" }, { "name": "An error encountered by the server, returned as a model with an error\ncode and a description.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" }, { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" } ], "url": { "raw": "{{baseUrl}}/users/:userId/followees/:anotherUserId?fields=[object Object]", "host": [ "{{baseUrl}}" ], "path": [ "users", ":userId", "followees", ":anotherUserId" ], "query": [ { "key": "fields", "value": "[object Object]" } ], "variable": [ { "key": "userId" }, { "key": "anotherUserId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "", "description": "The ETag." }, { "key": "Content-Language", "value": "", "description": "The preffered language of the user." }, { "key": "Content-Type", "value": "application/vnd.yellowfin.api-v1+json" } ], "cookie": [], "body": "{\n \"errorCode\": 401,\n \"reason\": \"INVALID_CREDENTIALS\",\n \"description\": \"Problem with the token or signature\"\n}" } ] }, { "name": "Remove a users' followee.", "request": { "auth": { "type": "noauth" }, "method": "DELETE", "header": [ { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" } ], "url": { "raw": "{{baseUrl}}/users/:userId/followees/:anotherUserId", "host": [ "{{baseUrl}}" ], "path": [ "users", ":userId", "followees", ":anotherUserId" ], "variable": [ { "key": "userId", "value": "", "description": "(Required) The Id of the user." }, { "key": "anotherUserId", "value": "", "description": "(Required) The Id of another user." } ] } }, "response": [ { "name": "An error encountered by the server, returned as a model with an error\ncode and a description.\n", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" }, { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" } ], "url": { "raw": "{{baseUrl}}/users/:userId/followees/:anotherUserId", "host": [ "{{baseUrl}}" ], "path": [ "users", ":userId", "followees", ":anotherUserId" ], "variable": [ { "key": "userId" }, { "key": "anotherUserId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "", "description": "The ETag." }, { "key": "Content-Language", "value": "", "description": "The preffered language of the user." }, { "key": "Content-Type", "value": "application/vnd.yellowfin.api-v1+json" } ], "cookie": [], "body": "{\n \"errorCode\": 401,\n \"reason\": \"INVALID_CREDENTIALS\",\n \"description\": \"Problem with the token or signature\"\n}" }, { "name": "Links for performing operations on a user followee list.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/users/:userId/followees/:anotherUserId", "host": [ "{{baseUrl}}" ], "path": [ "users", ":userId", "followees", ":anotherUserId" ], "variable": [ { "key": "userId" }, { "key": "anotherUserId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "", "description": "The ETag." }, { "key": "Content-Language", "value": "", "description": "The preffered language of the user." }, { "key": "Content-Type", "value": "application/vnd.yellowfin.api-v1+json" } ], "cookie": [], "body": "{\n \"_links\": {\n \"follow\": {\n \"href\": \"/api/users/12345/followees/56789\",\n \"options\": [\n \"POST\"\n ]\n },\n \"menu\": {\n \"href\": \"/api/menus/mobile-menu\",\n \"options\": [\n \"GET\"\n ]\n },\n \"subjectUser\": {\n \"href\": \"/api/users/12345\",\n \"options\": [\n \"GET\"\n ]\n },\n \"objectUser\": {\n \"href\": \"/api/users/56789\",\n \"options\": [\n \"GET\"\n ]\n }\n }\n}" } ] } ] }, { "name": "Get the users followed by userId. The returned list can be filtered, and\nsorted. The returned models can have their fields restricted.\n", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" } ], "url": { "raw": "{{baseUrl}}/users/:userId/followees?fields={}&filters=[{\"propertyName\":\"\",\"operator\":\"\",\"valueOne\":\"\",\"valueTwo\":\"\"},{\"propertyName\":\"\",\"operator\":\"\",\"valueOne\":\"\",\"valueTwo\":\"\"}]&sortModels=[{\"sortProperty\":\"\",\"sortAscending\":true},{\"sortProperty\":\"\",\"sortAscending\":true}]&limit=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":userId", "followees" ], "query": [ { "key": "fields", "value": "{}", "description": "The properties that should be returned in the requested model or list of\nmodels\n" }, { "key": "filters", "value": "[{\"propertyName\":\"\",\"operator\":\"\",\"valueOne\":\"\",\"valueTwo\":\"\"},{\"propertyName\":\"\",\"operator\":\"\",\"valueOne\":\"\",\"valueTwo\":\"\"}]", "description": "The filters that are to be applied to the requested model or list of\nmodels\n" }, { "key": "sortModels", "value": "[{\"sortProperty\":\"\",\"sortAscending\":true},{\"sortProperty\":\"\",\"sortAscending\":true}]", "description": "The sorting that should be applied to the requested model or list of\nmodels\n" }, { "key": "limit", "value": "", "description": "The maximum amount of items that should be returned in the response." } ], "variable": [ { "key": "userId", "value": "", "description": "(Required) The Id of the user." } ] } }, "response": [ { "name": "An error encountered by the server, returned as a model with an error\ncode and a description.\n", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" }, { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" } ], "url": { "raw": "{{baseUrl}}/users/:userId/followees?fields=[object Object]&filters=[object Object],[object Object]&sortModels=[object Object],[object Object]&limit=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":userId", "followees" ], "query": [ { "key": "fields", "value": "[object Object]" }, { "key": "filters", "value": "[object Object],[object Object]" }, { "key": "sortModels", "value": "[object Object],[object Object]" }, { "key": "limit", "value": "" } ], "variable": [ { "key": "userId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "", "description": "The ETag." }, { "key": "Content-Language", "value": "", "description": "The preffered language of the user." }, { "key": "Content-Type", "value": "application/vnd.yellowfin.api-v1+json" } ], "cookie": [], "body": "{\n \"errorCode\": 401,\n \"reason\": \"INVALID_CREDENTIALS\",\n \"description\": \"Problem with the token or signature\"\n}" }, { "name": "A list of user's followees.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/users/:userId/followees?fields=[object Object]&filters=[object Object],[object Object]&sortModels=[object Object],[object Object]&limit=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":userId", "followees" ], "query": [ { "key": "fields", "value": "[object Object]" }, { "key": "filters", "value": "[object Object],[object Object]" }, { "key": "sortModels", "value": "[object Object],[object Object]" }, { "key": "limit", "value": "" } ], "variable": [ { "key": "userId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "", "description": "The ETag." }, { "key": "Content-Language", "value": "", "description": "The preffered language of the user." }, { "key": "Content-Type", "value": "application/vnd.yellowfin.api-v1+json" } ], "cookie": [], "body": "{\n \"items\": [\n {\n \"userId\": 12345,\n \"name\": \"Bobbo\",\n \"title\": \"CEO\",\n \"userConnectionStatus\": \"CONNECTED\",\n \"_links\": {\n \"self\": {\n \"href\": \"/api/users/12345\",\n \"options\": [\n \"GET\"\n ]\n },\n \"follow\": {\n \"href\": \"/api/users/5/followees/56789\",\n \"options\": [\n \"DELETE\"\n ]\n }\n },\n \"_embedded\": {\n \"avatar\": {\n \"description\": \"A Picture of a Dog.\",\n \"_links\": {\n \"self\": {\n \"href\": \"/api/users/12345/avatar\",\n \"options\": [\n \"GET\"\n ]\n }\n }\n }\n }\n }\n ],\n \"_links\": {\n \"self\": {\n \"href\": \"/api/users/5/followees\",\n \"options\": [\n \"GET\"\n ]\n },\n \"next\": {\n \"href\": \"/api/users/5/followees?continue=20000101_12345\",\n \"options\": [\n \"GET\"\n ]\n },\n \"menu\": {\n \"href\": \"/api/menus/mobile-menu\",\n \"options\": [\n \"GET\"\n ]\n }\n }\n}" } ] } ] }, { "name": "followers", "item": [ { "name": "Get all the followers of a user. The returned list can be filtered, and\nsorted. The returned models can have their fields restricted.\n", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" } ], "url": { "raw": "{{baseUrl}}/users/:userId/followers?fields={}&filters=[{\"propertyName\":\"\",\"operator\":\"\",\"valueOne\":\"\",\"valueTwo\":\"\"},{\"propertyName\":\"\",\"operator\":\"\",\"valueOne\":\"\",\"valueTwo\":\"\"}]&sortModels=[{\"sortProperty\":\"\",\"sortAscending\":true},{\"sortProperty\":\"\",\"sortAscending\":true}]&limit=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":userId", "followers" ], "query": [ { "key": "fields", "value": "{}", "description": "The properties that should be returned in the requested model or list of\nmodels\n" }, { "key": "filters", "value": "[{\"propertyName\":\"\",\"operator\":\"\",\"valueOne\":\"\",\"valueTwo\":\"\"},{\"propertyName\":\"\",\"operator\":\"\",\"valueOne\":\"\",\"valueTwo\":\"\"}]", "description": "The filters that are to be applied to the requested model or list of\nmodels\n" }, { "key": "sortModels", "value": "[{\"sortProperty\":\"\",\"sortAscending\":true},{\"sortProperty\":\"\",\"sortAscending\":true}]", "description": "The sorting that should be applied to the requested model or list of\nmodels\n" }, { "key": "limit", "value": "", "description": "The maximum amount of items that should be returned in the response." } ], "variable": [ { "key": "userId", "value": "", "description": "(Required) The Id of the user." } ] } }, "response": [ { "name": "An error encountered by the server, returned as a model with an error\ncode and a description.\n", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" }, { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" } ], "url": { "raw": "{{baseUrl}}/users/:userId/followers?fields=[object Object]&filters=[object Object],[object Object]&sortModels=[object Object],[object Object]&limit=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":userId", "followers" ], "query": [ { "key": "fields", "value": "[object Object]" }, { "key": "filters", "value": "[object Object],[object Object]" }, { "key": "sortModels", "value": "[object Object],[object Object]" }, { "key": "limit", "value": "" } ], "variable": [ { "key": "userId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "", "description": "The ETag." }, { "key": "Content-Language", "value": "", "description": "The preffered language of the user." }, { "key": "Content-Type", "value": "application/vnd.yellowfin.api-v1+json" } ], "cookie": [], "body": "{\n \"errorCode\": 401,\n \"reason\": \"INVALID_CREDENTIALS\",\n \"description\": \"Problem with the token or signature\"\n}" }, { "name": "A list of user's followers.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/users/:userId/followers?fields=[object Object]&filters=[object Object],[object Object]&sortModels=[object Object],[object Object]&limit=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":userId", "followers" ], "query": [ { "key": "fields", "value": "[object Object]" }, { "key": "filters", "value": "[object Object],[object Object]" }, { "key": "sortModels", "value": "[object Object],[object Object]" }, { "key": "limit", "value": "" } ], "variable": [ { "key": "userId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "", "description": "The ETag." }, { "key": "Content-Language", "value": "", "description": "The preffered language of the user." }, { "key": "Content-Type", "value": "application/vnd.yellowfin.api-v1+json" } ], "cookie": [], "body": "{\n \"items\": [\n {\n \"userId\": 12345,\n \"name\": \"Bobbo\",\n \"title\": \"CEO\",\n \"userConnectionStatus\": \"CONNECTED\",\n \"_links\": {\n \"self\": {\n \"href\": \"/api/users/12345\",\n \"options\": [\n \"GET\"\n ]\n },\n \"follow\": {\n \"href\": \"/api/users/5/followees/56789\",\n \"options\": [\n \"DELETE\"\n ]\n }\n },\n \"_embedded\": {\n \"avatar\": {\n \"description\": \"A Picture of a Dog.\",\n \"_links\": {\n \"self\": {\n \"href\": \"/api/users/12345/avatar\",\n \"options\": [\n \"GET\"\n ]\n }\n }\n }\n }\n }\n ],\n \"_links\": {\n \"self\": {\n \"href\": \"/api/users/5/followers\",\n \"options\": [\n \"GET\"\n ]\n },\n \"next\": {\n \"href\": \"/api/users/5/followers?continue=20000101_12345\",\n \"options\": [\n \"GET\"\n ]\n },\n \"menu\": {\n \"href\": \"/api/menus/mobile-menu\",\n \"options\": [\n \"GET\"\n ]\n }\n }\n}" } ] }, { "name": "Confirm a users' follower.", "request": { "auth": { "type": "noauth" }, "method": "PUT", "header": [ { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" } ], "url": { "raw": "{{baseUrl}}/users/:userId/followers/:followerId?fields={}", "host": [ "{{baseUrl}}" ], "path": [ "users", ":userId", "followers", ":followerId" ], "query": [ { "key": "fields", "value": "{}", "description": "The properties that should be returned in the requested model or list of\nmodels\n" } ], "variable": [ { "key": "userId", "value": "", "description": "(Required) The Id of the user." }, { "key": "followerId", "value": "", "description": "(Required) The Id of foilower." } ] } }, "response": [ { "name": "An error encountered by the server, returned as a model with an error\ncode and a description.\n", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" }, { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" } ], "url": { "raw": "{{baseUrl}}/users/:userId/followers/:followerId?fields=[object Object]", "host": [ "{{baseUrl}}" ], "path": [ "users", ":userId", "followers", ":followerId" ], "query": [ { "key": "fields", "value": "[object Object]" } ], "variable": [ { "key": "userId" }, { "key": "followerId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "", "description": "The ETag." }, { "key": "Content-Language", "value": "", "description": "The preffered language of the user." }, { "key": "Content-Type", "value": "application/vnd.yellowfin.api-v1+json" } ], "cookie": [], "body": "{\n \"errorCode\": 401,\n \"reason\": \"INVALID_CREDENTIALS\",\n \"description\": \"Problem with the token or signature\"\n}" }, { "name": "Links for performing operations on a follower.", "originalRequest": { "method": "PUT", "header": [], "url": { "raw": "{{baseUrl}}/users/:userId/followers/:followerId?fields=[object Object]", "host": [ "{{baseUrl}}" ], "path": [ "users", ":userId", "followers", ":followerId" ], "query": [ { "key": "fields", "value": "[object Object]" } ], "variable": [ { "key": "userId" }, { "key": "followerId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "", "description": "The ETag." }, { "key": "Content-Language", "value": "", "description": "The preffered language of the user." }, { "key": "Content-Type", "value": "application/vnd.yellowfin.api-v1+json" } ], "cookie": [], "body": "{\n \"subjectUserId\": 12345,\n \"objectUserId\": 67890,\n \"userConnectionStatus\": \"CONNECTED\",\n \"_links\": {\n \"self\": {\n \"href\": \"/api/users/12345/followers/67890\",\n \"options\": [\n \"DELETE\"\n ]\n },\n \"menu\": {\n \"href\": \"/api/menus/mobile-menu\",\n \"options\": [\n \"GET\"\n ]\n },\n \"subjectUser\": {\n \"href\": \"/api/users/12345\",\n \"options\": [\n \"GET\"\n ]\n },\n \"objectUser\": {\n \"href\": \"/api/users/67890\",\n \"options\": [\n \"GET\"\n ]\n }\n }\n}" } ] } ] }, { "name": "favourites", "item": [ { "name": "{content Type}/{favourite Content Id}", "item": [ { "name": "Favourite content.", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" } ], "url": { "raw": "{{baseUrl}}/users/:userId/favourites/:contentType/:favouriteContentId?fields={}", "host": [ "{{baseUrl}}" ], "path": [ "users", ":userId", "favourites", ":contentType", ":favouriteContentId" ], "query": [ { "key": "fields", "value": "{}", "description": "The properties that should be returned in the requested model or list of\nmodels\n" } ], "variable": [ { "key": "userId", "value": "", "description": "(Required) The Id of the user." }, { "key": "contentType", "value": "", "description": "(Required) A type of content, as a path variable." }, { "key": "favouriteContentId", "value": "", "description": "(Required) An integer id for a piece of content that has been favourited." } ] } }, "response": [ { "name": "An error encountered by the server, returned as a model with an error\ncode and a description.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" }, { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" } ], "url": { "raw": "{{baseUrl}}/users/:userId/favourites/:contentType/:favouriteContentId?fields=[object Object]", "host": [ "{{baseUrl}}" ], "path": [ "users", ":userId", "favourites", ":contentType", ":favouriteContentId" ], "query": [ { "key": "fields", "value": "[object Object]" } ], "variable": [ { "key": "userId" }, { "key": "contentType" }, { "key": "favouriteContentId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "", "description": "The ETag." }, { "key": "Content-Language", "value": "", "description": "The preffered language of the user." }, { "key": "Content-Type", "value": "application/vnd.yellowfin.api-v1+json" } ], "cookie": [], "body": "{\n \"errorCode\": 401,\n \"reason\": \"INVALID_CREDENTIALS\",\n \"description\": \"Problem with the token or signature\"\n}" }, { "name": "A response for when content has been favourited.", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/users/:userId/favourites/:contentType/:favouriteContentId?fields=[object Object]", "host": [ "{{baseUrl}}" ], "path": [ "users", ":userId", "favourites", ":contentType", ":favouriteContentId" ], "query": [ { "key": "fields", "value": "[object Object]" } ], "variable": [ { "key": "userId" }, { "key": "contentType" }, { "key": "favouriteContentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "", "description": "The ETag." }, { "key": "Content-Language", "value": "", "description": "The preffered language of the user." }, { "key": "Content-Type", "value": "application/vnd.yellowfin.api-v1+json" } ], "cookie": [], "body": "{\n \"userId\": 12345,\n \"name\": \"Boboo\",\n \"contentType\": \"story\",\n \"title\": \"A Story Title\",\n \"description\": \"A story description\",\n \"contentId\": 12345,\n \"contentUuid\": \"5678f33c-c666-4972-8976-9c489accf73b\",\n \"publishedDate\": \"20190306034406\",\n \"_links\": {\n \"self\": {\n \"href\": \"/api/users/12345/favourites/stories/12345\",\n \"options\": [\n \"DELETE\"\n ]\n },\n \"menu\": {\n \"href\": \"/api/menus/mobile-menu\",\n \"options\": [\n \"GET\"\n ]\n }\n }\n}" } ] }, { "name": "Un-favoutire content.", "request": { "auth": { "type": "noauth" }, "method": "DELETE", "header": [ { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" } ], "url": { "raw": "{{baseUrl}}/users/:userId/favourites/:contentType/:favouriteContentId", "host": [ "{{baseUrl}}" ], "path": [ "users", ":userId", "favourites", ":contentType", ":favouriteContentId" ], "variable": [ { "key": "userId", "value": "", "description": "(Required) The Id of the user." }, { "key": "contentType", "value": "", "description": "(Required) A type of content, as a path variable." }, { "key": "favouriteContentId", "value": "", "description": "(Required) An integer id for a piece of content that has been favourited." } ] } }, "response": [ { "name": "An error encountered by the server, returned as a model with an error\ncode and a description.\n", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" }, { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" } ], "url": { "raw": "{{baseUrl}}/users/:userId/favourites/:contentType/:favouriteContentId", "host": [ "{{baseUrl}}" ], "path": [ "users", ":userId", "favourites", ":contentType", ":favouriteContentId" ], "variable": [ { "key": "userId" }, { "key": "contentType" }, { "key": "favouriteContentId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "", "description": "The ETag." }, { "key": "Content-Language", "value": "", "description": "The preffered language of the user." }, { "key": "Content-Type", "value": "application/vnd.yellowfin.api-v1+json" } ], "cookie": [], "body": "{\n \"errorCode\": 401,\n \"reason\": \"INVALID_CREDENTIALS\",\n \"description\": \"Problem with the token or signature\"\n}" }, { "name": "Possible links that are returned when a content favourite is removed.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/users/:userId/favourites/:contentType/:favouriteContentId", "host": [ "{{baseUrl}}" ], "path": [ "users", ":userId", "favourites", ":contentType", ":favouriteContentId" ], "variable": [ { "key": "userId" }, { "key": "contentType" }, { "key": "favouriteContentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "", "description": "The ETag." }, { "key": "Content-Language", "value": "", "description": "The preffered language of the user." }, { "key": "Content-Type", "value": "application/vnd.yellowfin.api-v1+json" } ], "cookie": [], "body": "{\n \"_links\": {\n \"favourite\": {\n \"href\": \"/api/users/12345/favourites/story/67890\",\n \"options\": [\n \"GET\"\n ]\n },\n \"content\": {\n \"href\": \"/api/stories/5678f33c-c666-4972-8976-9c489accf73b\",\n \"options\": [\n \"GET\"\n ]\n },\n \"menu\": {\n \"href\": \"/api/menus/mobile-menu\",\n \"options\": [\n \"GET\"\n ]\n }\n }\n}" } ] } ] }, { "name": "Get a users' favourites. The returned list can be filtered, and sorted.\nThe returned models can have their fields restricted.\n", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" } ], "url": { "raw": "{{baseUrl}}/users/:userId/favourites?fields={}&filters=[{\"propertyName\":\"\",\"operator\":\"\",\"valueOne\":\"\",\"valueTwo\":\"\"},{\"propertyName\":\"\",\"operator\":\"\",\"valueOne\":\"\",\"valueTwo\":\"\"}]&sortModels=[{\"sortProperty\":\"\",\"sortAscending\":true},{\"sortProperty\":\"\",\"sortAscending\":true}]&limit=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":userId", "favourites" ], "query": [ { "key": "fields", "value": "{}", "description": "The properties that should be returned in the requested model or list of\nmodels\n" }, { "key": "filters", "value": "[{\"propertyName\":\"\",\"operator\":\"\",\"valueOne\":\"\",\"valueTwo\":\"\"},{\"propertyName\":\"\",\"operator\":\"\",\"valueOne\":\"\",\"valueTwo\":\"\"}]", "description": "The filters that are to be applied to the requested model or list of\nmodels\n" }, { "key": "sortModels", "value": "[{\"sortProperty\":\"\",\"sortAscending\":true},{\"sortProperty\":\"\",\"sortAscending\":true}]", "description": "The sorting that should be applied to the requested model or list of\nmodels\n" }, { "key": "limit", "value": "", "description": "The maximum amount of items that should be returned in the response." } ], "variable": [ { "key": "userId", "value": "", "description": "(Required) The Id of the user." } ] } }, "response": [ { "name": "A list of models of varying type of content that the user has\nfavourited.\n", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/users/:userId/favourites?fields=[object Object]&filters=[object Object],[object Object]&sortModels=[object Object],[object Object]&limit=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":userId", "favourites" ], "query": [ { "key": "fields", "value": "[object Object]" }, { "key": "filters", "value": "[object Object],[object Object]" }, { "key": "sortModels", "value": "[object Object],[object Object]" }, { "key": "limit", "value": "" } ], "variable": [ { "key": "userId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "", "description": "The ETag." }, { "key": "Content-Language", "value": "", "description": "The preffered language of the user." }, { "key": "Content-Type", "value": "application/vnd.yellowfin.api-v1+json" } ], "cookie": [], "body": "{\n \"items\": [\n {\n \"userId\": 12345,\n \"name\": \"Boboo\",\n \"contentType\": \"story\",\n \"title\": \"A Story Title\",\n \"description\": \"A story description\",\n \"contentId\": 12345,\n \"contentUuid\": \"5678f33c-c666-4972-8976-9c489accf73b\",\n \"publishedDate\": \"20190306034406\",\n \"_links\": {\n \"self\": {\n \"href\": \"/api/users/12345/favourites/stories/12345\",\n \"options\": [\n \"DELETE\"\n ]\n },\n \"content\": {\n \"href\": \"/api/stories/5678f33c-c666-4972-8976-9c489accf73b\",\n \"options\": [\n \"GET\"\n ]\n }\n }\n }\n ],\n \"_links\": {\n \"self\": {\n \"href\": \"/api/users/12345/favourites\",\n \"options\": [\n \"GET\"\n ]\n },\n \"next\": {\n \"href\": \"/api/users/12345/favourites?continue=20000101_12345\",\n \"options\": [\n \"GET\"\n ]\n },\n \"menu\": {\n \"href\": \"/api/menus/mobile-menu\",\n \"options\": [\n \"GET\"\n ]\n }\n }\n}" }, { "name": "An error encountered by the server, returned as a model with an error\ncode and a description.\n", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" }, { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" } ], "url": { "raw": "{{baseUrl}}/users/:userId/favourites?fields=[object Object]&filters=[object Object],[object Object]&sortModels=[object Object],[object Object]&limit=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":userId", "favourites" ], "query": [ { "key": "fields", "value": "[object Object]" }, { "key": "filters", "value": "[object Object],[object Object]" }, { "key": "sortModels", "value": "[object Object],[object Object]" }, { "key": "limit", "value": "" } ], "variable": [ { "key": "userId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "", "description": "The ETag." }, { "key": "Content-Language", "value": "", "description": "The preffered language of the user." }, { "key": "Content-Type", "value": "application/vnd.yellowfin.api-v1+json" } ], "cookie": [], "body": "{\n \"errorCode\": 401,\n \"reason\": \"INVALID_CREDENTIALS\",\n \"description\": \"Problem with the token or signature\"\n}" } ] } ] }, { "name": "Get a user. The returned model can have its fields restricted.", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" } ], "url": { "raw": "{{baseUrl}}/users/:userId?fields={}", "host": [ "{{baseUrl}}" ], "path": [ "users", ":userId" ], "query": [ { "key": "fields", "value": "{}", "description": "The properties that should be returned in the requested model or list of\nmodels\n" } ], "variable": [ { "key": "userId", "value": "", "description": "(Required) The Id of the user." } ] } }, "response": [ { "name": "A user model.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/users/:userId?fields=[object Object]", "host": [ "{{baseUrl}}" ], "path": [ "users", ":userId" ], "query": [ { "key": "fields", "value": "[object Object]" } ], "variable": [ { "key": "userId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "", "description": "The ETag." }, { "key": "Content-Language", "value": "", "description": "The preffered language of the user." }, { "key": "Content-Type", "value": "application/vnd.yellowfin.api-v1+json" } ], "cookie": [], "body": "{\n \"userId\": 12345,\n \"name\": \"Bobbo\",\n \"title\": \"CEO\",\n \"description\": \"Not much to say\",\n \"userConnectionStatus\": \"NOT_CONNECTED\",\n \"isCurrentUser\": false,\n \"numStories\": 123,\n \"numFollowers\": 1000000,\n \"numFollowing\": 0,\n \"numDiscussionStreams\": 4,\n \"_links\": {\n \"self\": {\n \"href\": \"/api/users/12345\",\n \"options\": [\n \"GET\"\n ]\n },\n \"followers\": {\n \"href\": \"/api/users/12345/followers\",\n \"options\": [\n \"GET\"\n ]\n },\n \"followees\": {\n \"href\": \"/api/users/12345/followees\",\n \"options\": [\n \"GET\"\n ]\n },\n \"discussionStreams\": {\n \"href\": \"/api/discussion-streams\"\n },\n \"stories\": {\n \"href\": \"/api/stories/filters=[{\\\"propertyName\\\":\\\"author\\\",\\\"operator\\\":\\\"equalTo\\\",\\\"valueOne\\\":\\\"12345\\\"}]\\n\",\n \"options\": [\n \"GET\"\n ]\n },\n \"timeline\": {\n \"href\": \"Not yet implemented\"\n },\n \"follow\": {\n \"href\": \"/api/users/12345/followees/67890\",\n \"options\": [\n \"POST\"\n ]\n },\n \"menu\": {\n \"href\": \"/api/menus/mobile-menu\",\n \"options\": [\n \"GET\"\n ]\n }\n },\n \"_embedded\": {\n \"avatar\": {\n \"description\": \"A Picture of a Dog.\",\n \"_links\": {\n \"self\": {\n \"href\": \"/api/users/12345/avatar\",\n \"options\": [\n \"GET\"\n ]\n }\n }\n },\n \"activities\": [\n {\n \"notificationId\": 12345,\n \"notificationType\": \"REGULAR\",\n \"titleText\": {\n \"unformattedText\": \"{0} clapped a story {1}\",\n \"formatSegments\": [\n {\n \"rawText\": \"Jane Doe\",\n \"styles\": [\n \"BOLD\"\n ]\n },\n {\n \"rawText\": \"A detailed look back at 2018\",\n \"styles\": [\n \"LINK\"\n ],\n \"linkedType\": \"STORY\",\n \"_links\": {\n \"link\": \"/api/stories/a236-asad-0fas-asdf\"\n }\n }\n ]\n },\n \"dateTime\": 20190222153804,\n \"_embedded\": {\n \"titleImage\": {\n \"_links\": {\n \"self\": {\n \"href\": \"/api/users/1234/avatar\",\n \"options\": [\n \"GET\"\n ]\n }\n }\n }\n },\n \"_links\": {\n \"activity\": {\n \"href\": \"/api/notifications\",\n \"options\": [\n \"GET\"\n ]\n }\n }\n }\n ]\n }\n}" }, { "name": "An error encountered by the server, returned as a model with an error\ncode and a description.\n", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" }, { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" } ], "url": { "raw": "{{baseUrl}}/users/:userId?fields=[object Object]", "host": [ "{{baseUrl}}" ], "path": [ "users", ":userId" ], "query": [ { "key": "fields", "value": "[object Object]" } ], "variable": [ { "key": "userId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "", "description": "The ETag." }, { "key": "Content-Language", "value": "", "description": "The preffered language of the user." }, { "key": "Content-Type", "value": "application/vnd.yellowfin.api-v1+json" } ], "cookie": [], "body": "{\n \"errorCode\": 401,\n \"reason\": \"INVALID_CREDENTIALS\",\n \"description\": \"Problem with the token or signature\"\n}" } ] }, { "name": "Update a user.", "request": { "auth": { "type": "noauth" }, "method": "PATCH", "header": [ { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" }, { "key": "Content-Type", "value": "multipart/form-data" } ], "body": { "mode": "raw", "raw": "{\r\n \"userTitle: \"title\",\r\n \"description\": \"desc\"\r\n}" }, "url": { "raw": "{{baseUrl}}/users/:userId", "host": [ "{{baseUrl}}" ], "path": [ "users", ":userId" ], "query": [ { "key": "fields", "value": "{}", "description": "The properties that should be returned in the requested model or list of\nmodels\n", "disabled": true } ], "variable": [ { "key": "userId", "value": "13007", "description": "(Required) The Id of the user." } ] } }, "response": [ { "name": "A response for when a user has been updated.", "originalRequest": { "method": "PATCH", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "userTitle", "value": "" }, { "key": "description", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/users/:userId?fields=[object Object]", "host": [ "{{baseUrl}}" ], "path": [ "users", ":userId" ], "query": [ { "key": "fields", "value": "[object Object]" } ], "variable": [ { "key": "userId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "", "description": "The ETag." }, { "key": "Content-Language", "value": "", "description": "The preffered language of the user." }, { "key": "Content-Type", "value": "application/vnd.yellowfin.api-v1+json" } ], "cookie": [], "body": "{\n \"userId\": 12345,\n \"name\": \"Bobbo\",\n \"title\": \"CEO\",\n \"description\": \"Not much to say\",\n \"isCurrentUser\": true,\n \"numStories\": 123,\n \"numFollowers\": 1000000,\n \"numFollowing\": 0,\n \"numDiscussionStreams\": 4,\n \"_links\": {\n \"self\": {\n \"href\": \"/api/users/12345\",\n \"options\": [\n \"GET\",\n \"PATCH\"\n ]\n },\n \"followers\": {\n \"href\": \"/api/users/12345/followers\",\n \"options\": [\n \"GET\"\n ]\n },\n \"followees\": {\n \"href\": \"/api/users/12345/followees\",\n \"options\": [\n \"GET\"\n ]\n },\n \"discussionStreams\": {\n \"href\": \"Not yet implemented\"\n },\n \"stories\": {\n \"href\": \"/api/stories\",\n \"options\": [\n \"GET\"\n ]\n },\n \"timeline\": {\n \"href\": \"Not yet implemented\"\n }\n },\n \"_embedded\": {\n \"avatar\": {\n \"description\": \"A Picture of a Dog.\",\n \"_links\": {\n \"self\": {\n \"href\": \"/api/users/12345/avatar\",\n \"options\": [\n \"GET\"\n ]\n }\n }\n }\n }\n}" }, { "name": "An error encountered by the server, returned as a model with an error\ncode and a description.\n", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" }, { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" } ], "body": { "mode": "formdata", "formdata": [ { "key": "userTitle", "value": "" }, { "key": "description", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/users/:userId?fields=[object Object]", "host": [ "{{baseUrl}}" ], "path": [ "users", ":userId" ], "query": [ { "key": "fields", "value": "[object Object]" } ], "variable": [ { "key": "userId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "", "description": "The ETag." }, { "key": "Content-Language", "value": "", "description": "The preffered language of the user." }, { "key": "Content-Type", "value": "application/vnd.yellowfin.api-v1+json" } ], "cookie": [], "body": "{\n \"errorCode\": 401,\n \"reason\": \"INVALID_CREDENTIALS\",\n \"description\": \"Problem with the token or signature\"\n}" } ] }, { "name": "Gets a list of all notifications for a user. The returned list can be\nfiltered, and sorted. The returned models \n\ncan have their fields restricted.\n", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" } ], "url": { "raw": "{{baseUrl}}/users/:userId/notifications?fields={}&filters=[{\"propertyName\":\"\",\"operator\":\"\",\"valueOne\":\"\",\"valueTwo\":\"\"},{\"propertyName\":\"\",\"operator\":\"\",\"valueOne\":\"\",\"valueTwo\":\"\"}]&sortModels=[{\"sortProperty\":\"\",\"sortAscending\":true},{\"sortProperty\":\"\",\"sortAscending\":true}]&limit=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":userId", "notifications" ], "query": [ { "key": "fields", "value": "{}", "description": "The properties that should be returned in the requested model or list of\nmodels\n" }, { "key": "filters", "value": "[{\"propertyName\":\"\",\"operator\":\"\",\"valueOne\":\"\",\"valueTwo\":\"\"},{\"propertyName\":\"\",\"operator\":\"\",\"valueOne\":\"\",\"valueTwo\":\"\"}]", "description": "The filters that are to be applied to the requested model or list of\nmodels\n" }, { "key": "sortModels", "value": "[{\"sortProperty\":\"\",\"sortAscending\":true},{\"sortProperty\":\"\",\"sortAscending\":true}]", "description": "The sorting that should be applied to the requested model or list of\nmodels\n" }, { "key": "limit", "value": "", "description": "The maximum amount of items that should be returned in the response." } ], "variable": [ { "key": "userId", "value": "", "description": "(Required) The Id of the user." } ] } }, "response": [ { "name": "An error encountered by the server, returned as a model with an error\ncode and a description.\n", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" }, { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" } ], "url": { "raw": "{{baseUrl}}/users/:userId/notifications?fields=[object Object]&filters=[object Object],[object Object]&sortModels=[object Object],[object Object]&limit=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":userId", "notifications" ], "query": [ { "key": "fields", "value": "[object Object]" }, { "key": "filters", "value": "[object Object],[object Object]" }, { "key": "sortModels", "value": "[object Object],[object Object]" }, { "key": "limit", "value": "" } ], "variable": [ { "key": "userId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "", "description": "The ETag." }, { "key": "Content-Language", "value": "", "description": "The preffered language of the user." }, { "key": "Content-Type", "value": "application/vnd.yellowfin.api-v1+json" } ], "cookie": [], "body": "{\n \"errorCode\": 401,\n \"reason\": \"INVALID_CREDENTIALS\",\n \"description\": \"Problem with the token or signature\"\n}" }, { "name": "A list of notification models.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/users/:userId/notifications?fields=[object Object]&filters=[object Object],[object Object]&sortModels=[object Object],[object Object]&limit=", "host": [ "{{baseUrl}}" ], "path": [ "users", ":userId", "notifications" ], "query": [ { "key": "fields", "value": "[object Object]" }, { "key": "filters", "value": "[object Object],[object Object]" }, { "key": "sortModels", "value": "[object Object],[object Object]" }, { "key": "limit", "value": "" } ], "variable": [ { "key": "userId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "", "description": "The ETag." }, { "key": "Content-Language", "value": "", "description": "The preffered language of the user." }, { "key": "Content-Type", "value": "application/vnd.yellowfin.api-v1+json" } ], "cookie": [], "body": "{\n \"items\": [\n {\n \"notificationId\": \"EVENT|257454\",\n \"type\": \"REGULAR\",\n \"titleText\": {\n \"formattedSegments\": [\n {\n \"rawSegment\": \"System Administrator\",\n \"styles\": [\n \"COMMENT_NAME_HIGHLIGHT\"\n ],\n \"linkedContentType\": \"PERSON\",\n \"linkedContentId\": 5,\n \"_links\": {\n \"self\": {\n \"href\": \"/api/users/5\",\n \"options\": [\n \"GET\"\n ]\n }\n }\n },\n {\n \"rawSegment\": \"U 1\",\n \"styles\": [\n \"COMMENT_NAME_HIGHLIGHT\"\n ],\n \"linkedContentType\": \"PERSON\",\n \"linkedContentId\": 13003,\n \"_links\": {\n \"self\": {\n \"href\": \"/api/users/13003\",\n \"options\": [\n \"GET\"\n ]\n }\n }\n }\n ],\n \"unformattedText\": \"{0} to {1}\",\n \"formatType\": \"FORMATTED_TEXT_MODEL\"\n },\n \"titleImageRedirectType\": \"PERSON\",\n \"dateTime\": 20190529110919,\n \"formattedDateTime\": \"Today at 11:09 am\",\n \"_links\": {\n \"titleImageRedirect\": {\n \"href\": \"/api/users/5\",\n \"options\": [\n \"GET\"\n ]\n }\n },\n \"_embedded\": {\n \"content\": {\n \"viewName\": \"Ski Team\",\n \"datePeriod\": \"Between 01-01-2000 to 01-01-2019\",\n \"description\": {\n \"formattedSegments\": [\n {\n \"rawSegment\": \"additional signals\",\n \"styles\": [\n null\n ]\n }\n ],\n \"unformattedText\": \"There are 34 {0} that may be of interest\",\n \"formatType\": \"FORMATTED_TEXT_MODEL\"\n },\n \"resourceType\": \"OTHER_SIGNAL\",\n \"_links\": {\n \"collection\": {\n \"href\": \"/api/signals\",\n \"options\": [\n \"GET\"\n ]\n }\n },\n \"_embedded\": {\n \"image\": {\n \"_links\": {\n \"self\": {\n \"href\": \"images/signal_browse_thumb.png\",\n \"options\": [\n \"GET\"\n ]\n }\n }\n }\n }\n },\n \"titleImage\": {\n \"isPlaceholder\": false,\n \"_links\": {\n \"self\": {\n \"href\": \"/users/5/avatar\",\n \"options\": [\n \"GET\"\n ]\n }\n }\n }\n }\n },\n {\n \"notificationId\": \"USERMESSAGETHREAD|31204\",\n \"type\": \"USER_COMMENT\",\n \"titleText\": {\n \"formattedSegments\": [\n {\n \"rawSegment\": \"System Administrator\",\n \"styles\": [\n \"COMMENT_NAME_HIGHLIGHT\"\n ],\n \"linkedContentType\": \"PERSON\",\n \"linkedContentId\": 5,\n \"_links\": {\n \"self\": {\n \"href\": \"/api/users/5\",\n \"options\": [\n \"GET\"\n ]\n }\n }\n }\n ],\n \"unformattedText\": \"{0}\",\n \"formatType\": \"FORMATTED_TEXT_MODEL\"\n },\n \"titleImageRedirectType\": \"PERSON\",\n \"dateTime\": 20190527153254,\n \"formattedDateTime\": \"May 27 at 3:32 pm\",\n \"_links\": {\n \"titleImageRedirect\": {\n \"href\": \"/api/users/5\",\n \"options\": [\n \"GET\"\n ]\n }\n },\n \"_embedded\": {\n \"comment\": {\n \"commentId\": 31204,\n \"userComment\": {\n \"formattedSegments\": [],\n \"unformattedText\": \"t6\",\n \"formatType\": \"FORMATTED_TEXT_MODEL\"\n },\n \"postDate\": 20190527053254,\n \"formattedDateTime\": \"27-05-2019 15:32:54\",\n \"replyCount\": 0,\n \"_links\": {\n \"self\": {\n \"href\": \"/api/comments/31204\",\n \"options\": [\n \"GET\",\n \"PATCH\",\n \"DELETE\"\n ]\n },\n \"replies\": {\n \"href\": \"/api/comments/31204/replies\",\n \"options\": [\n \"GET\",\n \"POST\"\n ]\n }\n },\n \"_embedded\": {\n \"attachments\": [\n {\n \"resourceType\": \"DISCUSSION_STREAM\",\n \"contentKey\": \"371569\",\n \"_links\": {\n \"self\": {\n \"href\": \"/api/discussion-streams/371569\",\n \"options\": [\n \"GET\"\n ]\n }\n }\n }\n ],\n \"author\": {\n \"userId\": 5,\n \"name\": \"System Administrator\",\n \"_links\": {\n \"self\": {\n \"href\": \"/api/users/5\",\n \"options\": [\n \"GET\"\n ]\n }\n },\n \"_embedded\": {\n \"avatar\": {\n \"_links\": {\n \"self\": {\n \"href\": \"/api/users/5/avatar\",\n \"options\": [\n \"GET\"\n ]\n }\n }\n }\n }\n },\n \"replies\": [\n {\n \"replyId\": 31207,\n \"commentId\": 31204,\n \"userComment\": {\n \"formattedSegments\": [],\n \"unformattedText\": \"t2\",\n \"formatType\": \"FORMATTED_TEXT_MODEL\"\n },\n \"postDate\": 20190528050556,\n \"formattedDateTime\": \"28-05-2019 15:05:56\",\n \"_links\": {\n \"self\": {\n \"href\": \"/api/comments/31206/replies/31207\",\n \"options\": [\n \"PATCH\",\n \"DELETE\"\n ]\n }\n },\n \"_embedded\": {\n \"author\": {\n \"userId\": 5,\n \"name\": \"System Administrator\",\n \"_links\": {\n \"self\": {\n \"href\": \"/api/users/5\",\n \"options\": [\n \"GET\"\n ]\n }\n },\n \"_embedded\": {\n \"avatar\": {\n \"_links\": {\n \"self\": {\n \"href\": \"/api/users/5/avatar\",\n \"options\": [\n \"GET\"\n ]\n }\n }\n }\n }\n }\n }\n }\n ]\n }\n },\n \"titleImage\": {\n \"isPlaceholder\": false,\n \"_links\": {\n \"self\": {\n \"href\": \"/users/5/avatar\",\n \"options\": [\n \"GET\"\n ]\n }\n }\n }\n }\n }\n ],\n \"_links\": {\n \"self\": {\n \"href\": \"/api/users/3456/notifications\",\n \"options\": [\n \"GET\"\n ]\n },\n \"menu\": {\n \"href\": \"/api/menus/mobile-menu\",\n \"options\": [\n \"GET\"\n ]\n }\n }\n}" } ] } ] }, { "name": "admin", "item": [ { "name": "{userId}", "item": [ { "name": "password", "item": [ { "name": "Change a user's password", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/vnd.yellowfin.api-v1+json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n\t\"password\": \"test\"\n}" }, "url": { "raw": "{{baseUrl}}/users/admin/:userId/password", "host": [ "{{baseUrl}}" ], "path": [ "users", "admin", ":userId", "password" ], "variable": [ { "key": "userId", "value": "5" } ] } }, "response": [] } ] }, { "name": "sessions", "item": [ { "name": "Terminate all of this user's sessions", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/vnd.yellowfin.api-v1+json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/users/admin/:userId/sessions", "host": [ "{{baseUrl}}" ], "path": [ "users", "admin", ":userId", "sessions" ], "variable": [ { "key": "userId", "value": "5" } ] } }, "response": [] } ] }, { "name": "org-access", "item": [ { "name": "{ipOrg}", "item": [ { "name": "Remove this user's access to an org", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/vnd.yellowfin.api-v1+json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/admin/users/:userId/org-access/:ipOrg", "host": [ "{{baseUrl}}" ], "path": [ "admin", "users", ":userId", "org-access", ":ipOrg" ], "variable": [ { "key": "userId", "value": "13002" }, { "key": "ipOrg", "value": "13001" } ] } }, "response": [] } ] }, { "name": "Get the list of client orgs this user has access to", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/vnd.yellowfin.api-v1+json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/admin/users/:userId/org-access", "host": [ "{{baseUrl}}" ], "path": [ "admin", "users", ":userId", "org-access" ], "variable": [ { "key": "userId", "value": "5" } ] } }, "response": [] }, { "name": "Grant this user access to an org", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/vnd.yellowfin.api-v1+json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"orgId\": 13001\r\n}" }, "url": { "raw": "{{baseUrl}}/admin/users/:userId/org-access", "host": [ "{{baseUrl}}" ], "path": [ "admin", "users", ":userId", "org-access" ], "variable": [ { "key": "userId", "value": "13002" } ] } }, "response": [] } ] }, { "name": "Get a single user admin resource", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/vnd.yellowfin.api-v1+json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/users/admin/:userId", "host": [ "{{baseUrl}}" ], "path": [ "users", "admin", ":userId" ], "variable": [ { "key": "userId", "value": "13018" } ] } }, "response": [] }, { "name": "Update a user admin resource", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/vnd.yellowfin.api-v1+json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"lastName\": \"Administrator\",\r\n \"firstName\": \"System\",\r\n \"languageCode\": \"EN\",\r\n \"emailAddress\": \"admin@yellowfin.com.au\",\r\n \"roleCode\": \"YFADMIN\",\r\n \"timeZoneCode\": \"AUSTRALIA/SYDNEY\"\r\n}" }, "url": { "raw": "{{baseUrl}}/users/admin/:userId", "host": [ "{{baseUrl}}" ], "path": [ "users", "admin", ":userId" ], "variable": [ { "key": "userId", "value": "5" } ] } }, "response": [] }, { "name": "Delete a single user admin resource", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/vnd.yellowfin.api-v1+json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/users/admin/:userId", "host": [ "{{baseUrl}}" ], "path": [ "users", "admin", ":userId" ], "variable": [ { "key": "userId", "value": "13018" } ] } }, "response": [] } ] }, { "name": "Get a list of user admin resources", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/vnd.yellowfin.api-v1.1+json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/admin/users", "host": [ "{{baseUrl}}" ], "path": [ "admin", "users" ] } }, "response": [] }, { "name": "Get a list of user admin resources Copy", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/vnd.yellowfin.api-v1.1+json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/admin/users", "host": [ "{{baseUrl}}" ], "path": [ "admin", "users" ] } }, "response": [] }, { "name": "Create one or more users", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/vnd.yellowfin.api-v1+json", "type": "text" } ], "body": { "mode": "raw", "raw": "[\n\t{\n\t \"lastName\": \"Testerton\",\n\t \"firstName\": \"Testy\",\n\t \"languageCode\": \"EN\",\n\t \"emailAddress\": \"t.testerton@test.com\",\n\t \"userId\": \"t.testerton@test.com\",\n\t \"roleCode\": \"YFADMIN\",\n\t \"timeZoneCode\": \"AUSTRALIA/SYDNEY\"\n\t}\n]" }, "url": { "raw": "{{baseUrl}}/admin/users", "host": [ "{{baseUrl}}" ], "path": [ "admin", "users" ] } }, "response": [] } ] }, { "name": "Gets a list of all users. The returned list can be filtered, and sorted.\nThe returned models can have their fields restricted.\n", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}", "type": "text", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "Content-Type", "value": "application/json", "type": "text", "description": "The ETag header. Optional request parameter." }, { "key": "Accept", "value": "application/vnd.yellowfin.api-v1+json", "type": "text", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" } ], "url": { "raw": "{{baseUrl}}/users", "host": [ "{{baseUrl}}" ], "path": [ "users" ], "query": [ { "key": "fields", "value": "{}", "description": "The properties that should be returned in the requested model or list of\nmodels\n", "disabled": true }, { "key": "filters", "value": "[{\"propertyName\":\"\",\"operator\":\"\",\"valueOne\":\"\",\"valueTwo\":\"\"},{\"propertyName\":\"\",\"operator\":\"\",\"valueOne\":\"\",\"valueTwo\":\"\"}]", "description": "The filters that are to be applied to the requested model or list of\nmodels\n", "disabled": true }, { "key": "sortModels", "value": "[{\"sortProperty\":\"\",\"sortAscending\":true},{\"sortProperty\":\"\",\"sortAscending\":true}]", "description": "The sorting that should be applied to the requested model or list of\nmodels\n", "disabled": true }, { "key": "limit", "value": "", "description": "The maximum amount of items that should be returned in the response.", "disabled": true } ] } }, "response": [ { "name": "A list of simple user models.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/users?fields=[object Object]&filters=[object Object],[object Object]&sortModels=[object Object],[object Object]&limit=", "host": [ "{{baseUrl}}" ], "path": [ "users" ], "query": [ { "key": "fields", "value": "[object Object]" }, { "key": "filters", "value": "[object Object],[object Object]" }, { "key": "sortModels", "value": "[object Object],[object Object]" }, { "key": "limit", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "", "description": "The ETag." }, { "key": "Content-Language", "value": "", "description": "The preffered language of the user." }, { "key": "Content-Type", "value": "application/vnd.yellowfin.api-v1+json" } ], "cookie": [], "body": "{\n \"items\": [\n {\n \"userId\": 12345,\n \"name\": \"Bobbo\",\n \"title\": \"CEO\",\n \"userConnectionStatus\": \"CONNECTED\",\n \"_links\": {\n \"self\": {\n \"href\": \"/api/users/12345\",\n \"options\": [\n \"GET\"\n ]\n },\n \"follow\": {\n \"href\": \"/api/users/5/followees/56789\",\n \"options\": [\n \"DELETE\"\n ]\n }\n },\n \"_embedded\": {\n \"avatar\": {\n \"description\": \"A Picture of a Dog.\",\n \"_links\": {\n \"self\": {\n \"href\": \"/api/users/12345/avatar\",\n \"options\": [\n \"GET\"\n ]\n }\n }\n }\n }\n }\n ],\n \"_links\": {\n \"self\": {\n \"href\": \"/api/users\",\n \"options\": [\n \"GET\"\n ]\n },\n \"next\": {\n \"href\": \"/api/users?continue=20000101_12345\",\n \"options\": [\n \"GET\"\n ]\n },\n \"menu\": {\n \"href\": \"/api/menus/mobile-menu\",\n \"options\": [\n \"GET\"\n ]\n }\n }\n}" }, { "name": "An error encountered by the server, returned as a model with an error\ncode and a description.\n", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" }, { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" } ], "url": { "raw": "{{baseUrl}}/users?fields=[object Object]&filters=[object Object],[object Object]&sortModels=[object Object],[object Object]&limit=", "host": [ "{{baseUrl}}" ], "path": [ "users" ], "query": [ { "key": "fields", "value": "[object Object]" }, { "key": "filters", "value": "[object Object],[object Object]" }, { "key": "sortModels", "value": "[object Object],[object Object]" }, { "key": "limit", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "", "description": "The ETag." }, { "key": "Content-Language", "value": "", "description": "The preffered language of the user." }, { "key": "Content-Type", "value": "application/vnd.yellowfin.api-v1+json" } ], "cookie": [], "body": "{\n \"errorCode\": 401,\n \"reason\": \"INVALID_CREDENTIALS\",\n \"description\": \"Problem with the token or signature\"\n}" } ] }, { "name": "Gets a list of all the filters and the values that can be applied on the\nUsers list page.\n", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}", "type": "text", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "Content-Type", "value": "application/json", "type": "text", "description": "The ETag header. Optional request parameter." }, { "key": "Accept", "value": "application/vnd.yellowfin.api-v1+json", "type": "text", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" } ], "url": { "raw": "{{baseUrl}}/users/metadata?requiredFilters=[\"\",\"\"]", "host": [ "{{baseUrl}}" ], "path": [ "users", "metadata" ], "query": [ { "key": "requiredFilters", "value": "[\"\",\"\"]", "description": "The list of filters that must be returned when calling /metadata" } ] } }, "response": [ { "name": "Consists of a list of filters that can be applied on a Users list", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/users/metadata?requiredFilters=,", "host": [ "{{baseUrl}}" ], "path": [ "users", "metadata" ], "query": [ { "key": "requiredFilters", "value": "," } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "", "description": "The ETag." }, { "key": "Content-Language", "value": "", "description": "The preffered language of the user." }, { "key": "Content-Type", "value": "application/vnd.yellowfin.api-v1+json" } ], "cookie": [], "body": "{\n \"items\": [\n {\n \"filterModel\": {\n \"propertyName\": \"relevance\",\n \"operator\": \"equalTo\"\n },\n \"filterValues\": [\n {\n \"displayText\": \"Following\",\n \"filterValueCode\": \"FOLLOWING\",\n \"isDefault\": true\n },\n {\n \"displayText\": \"All People\",\n \"filterValueCode\": \"ALL\",\n \"isDefault\": false\n }\n ]\n }\n ],\n \"_links\": {\n \"self\": {\n \"href\": \"/api/users/metadata\",\n \"options\": [\n \"GET\"\n ]\n },\n \"collection\": {\n \"href\": \"/api/users\",\n \"options\": [\n \"GET\"\n ]\n },\n \"menu\": {\n \"href\": \"/api/menus/mobile-menu\",\n \"options\": [\n \"GET\"\n ]\n }\n }\n}" }, { "name": "An error encountered by the server, returned as a model with an error\ncode and a description.\n", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" }, { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" } ], "url": { "raw": "{{baseUrl}}/users/metadata?requiredFilters=,", "host": [ "{{baseUrl}}" ], "path": [ "users", "metadata" ], "query": [ { "key": "requiredFilters", "value": "," } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "", "description": "The ETag." }, { "key": "Content-Language", "value": "", "description": "The preffered language of the user." }, { "key": "Content-Type", "value": "application/vnd.yellowfin.api-v1+json" } ], "cookie": [], "body": "{\n \"errorCode\": 401,\n \"reason\": \"INVALID_CREDENTIALS\",\n \"description\": \"Problem with the token or signature\"\n}" } ] } ] }, { "name": "user-groups", "item": [ { "name": "{groupId}", "item": [ { "name": "flat-users", "item": [ { "name": "Get the flattened list of users belonging to this group", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/vnd.yellowfin.api-v1+json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/user-groups/:groupId/flat-users", "host": [ "{{baseUrl}}" ], "path": [ "user-groups", ":groupId", "flat-users" ], "variable": [ { "key": "groupId", "value": "11950" } ] } }, "response": [] } ] }, { "name": "members", "item": [ { "name": "Get the list of members of this group", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/vnd.yellowfin.api-v1+json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/user-groups/:groupId/members", "host": [ "{{baseUrl}}" ], "path": [ "user-groups", ":groupId", "members" ], "variable": [ { "key": "groupId", "value": "11950" } ] } }, "response": [] }, { "name": "Bulk add one or more members to this group", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/vnd.yellowfin.api-v1+json", "type": "text" } ], "body": { "mode": "raw", "raw": "[\r\n {\r\n \"entityType\": \"PERSON\",\r\n \"entityId\": 5,\r\n \"membershipType\": \"INCLUDED\"\r\n }\r\n]" }, "url": { "raw": "{{baseUrl}}/user-groups/:groupId/members", "host": [ "{{baseUrl}}" ], "path": [ "user-groups", ":groupId", "members" ], "variable": [ { "key": "groupId", "value": "13025" } ] } }, "response": [] }, { "name": "Bulk update one or more members on this group", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/vnd.yellowfin.api-v1+json", "type": "text" } ], "body": { "mode": "raw", "raw": "[\r\n {\r\n \"memberId\": \"PERSON|5\",\r\n \"membershipType\": \"INCLUDED\"\r\n }\r\n]" }, "url": { "raw": "{{baseUrl}}/user-groups/:groupId/members", "host": [ "{{baseUrl}}" ], "path": [ "user-groups", ":groupId", "members" ], "variable": [ { "key": "groupId", "value": "13025" } ] } }, "response": [] }, { "name": "Bulk update one or more members on this group Copy", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/vnd.yellowfin.api-v1+json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/user-groups/:groupId/members?memberIds=PERSON%7C5%2C%20PERSON%7C5", "host": [ "{{baseUrl}}" ], "path": [ "user-groups", ":groupId", "members" ], "query": [ { "key": "memberIds", "value": "PERSON%7C5%2C%20PERSON%7C5" } ], "variable": [ { "key": "groupId", "value": "13025" } ] } }, "response": [] } ] }, { "name": "default-dashboards", "item": [ { "name": "Get the list of default dashboards for this group", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/vnd.yellowfin.api-v1+json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/user-groups/:groupId/default-dashboards", "host": [ "{{baseUrl}}" ], "path": [ "user-groups", ":groupId", "default-dashboards" ], "variable": [ { "key": "groupId", "value": "11950" } ] } }, "response": [] }, { "name": "Bulk add one or more default dashboards to this group", "request": { "method": "POST", "header": [ { "key": "Authorization", "type": "text", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}" }, { "key": "Content-Type", "type": "text", "value": "application/json" }, { "key": "Accept", "type": "text", "value": "application/vnd.yellowfin.api-v1+json" } ], "body": { "mode": "raw", "raw": "[\r\n {\r\n \"resourceId\": 61250\r\n }\r\n] " }, "url": { "raw": "{{baseUrl}}/user-groups/:groupId/default-dashboards", "host": [ "{{baseUrl}}" ], "path": [ "user-groups", ":groupId", "default-dashboards" ], "variable": [ { "key": "groupId", "value": "11950" } ] } }, "response": [] } ] }, { "name": "Get a single user group admin resource", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/vnd.yellowfin.api-v1+json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/user-groups/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "user-groups", ":groupId" ], "variable": [ { "key": "groupId", "value": "11950" } ] } }, "response": [] }, { "name": "Update a user group's details", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/vnd.yellowfin.api-v1+json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"groupName\": \"Test API Group\",\r\n \"groupDescription\": \"Created through the REST API for testing purposes, also updated as well.\",\r\n \"groupStatus\": \"DRAFT\",\r\n \"isSecureGroup\": false\r\n}" }, "url": { "raw": "{{baseUrl}}/user-groups/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "user-groups", ":groupId" ], "variable": [ { "key": "groupId", "value": "13025" } ] } }, "response": [] }, { "name": "Delete a user group", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/vnd.yellowfin.api-v1+json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/user-groups/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "user-groups", ":groupId" ], "variable": [ { "key": "groupId", "value": "13026" } ] } }, "response": [] } ] }, { "name": "metadata", "item": [ { "name": "Get the available filters for the group list", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/vnd.yellowfin.api-v1+json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/user-groups/metadata", "host": [ "{{baseUrl}}" ], "path": [ "user-groups", "metadata" ] } }, "response": [] } ] }, { "name": "Gets a list of all user groups. The returned list can be filtered, and\nsorted. The returned models can have their fields restricted.\n", "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "Authorization", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}", "type": "text", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "Content-Type", "value": "application/json", "type": "text", "description": "The ETag header. Optional request parameter." }, { "key": "Accept", "value": "application/vnd.yellowfin.api-v1+json", "type": "text", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" } ], "url": { "raw": "{{baseUrl}}/user-groups", "host": [ "{{baseUrl}}" ], "path": [ "user-groups" ], "query": [ { "key": "fields", "value": "{}", "description": "The properties that should be returned in the requested model or list of\nmodels\n", "disabled": true }, { "key": "filters", "value": "%5B%7B%22propertyName%22%3A%22STATUS%22%2C%22operator%22%3A%22EQUAL_TO%22%2C%22valueOne%22%3A%22ALL%22%7D%5D", "description": "The filters that are to be applied to the requested model or list of\nmodels\n", "disabled": true }, { "key": "sortModels", "value": "[{\"sortProperty\":\"\",\"sortAscending\":true},{\"sortProperty\":\"\",\"sortAscending\":true}]", "description": "The sorting that should be applied to the requested model or list of\nmodels\n", "disabled": true }, { "key": "limit", "value": "", "description": "The maximum amount of items that should be returned in the response.", "disabled": true } ] } }, "response": [ { "name": "A list of user group models.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/user-groups?fields=[object Object]&filters=[object Object],[object Object]&sortModels=[object Object],[object Object]&limit=", "host": [ "{{baseUrl}}" ], "path": [ "user-groups" ], "query": [ { "key": "fields", "value": "[object Object]" }, { "key": "filters", "value": "[object Object],[object Object]" }, { "key": "sortModels", "value": "[object Object],[object Object]" }, { "key": "limit", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "", "description": "The ETag." }, { "key": "Content-Language", "value": "", "description": "The preffered language of the user." }, { "key": "Content-Type", "value": "application/vnd.yellowfin.api-v1+json" } ], "cookie": [], "body": "{\n \"items\": [\n {\n \"groupId\": 12345,\n \"shortDescription\": \"Bobbo Group\"\n }\n ],\n \"_links\": {\n \"self\": {\n \"href\": \"/api/user-groups\",\n \"options\": [\n \"GET\"\n ]\n },\n \"next\": {\n \"href\": \"/api/user-groups?continue=20000101_12345\",\n \"options\": [\n \"GET\"\n ]\n },\n \"menu\": {\n \"href\": \"/api/menus/mobile-menu\",\n \"options\": [\n \"GET\"\n ]\n }\n }\n}" }, { "name": "An error encountered by the server, returned as a model with an error\ncode and a description.\n", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" }, { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "ETag", "value": "", "description": "The ETag header. Optional request parameter." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Every request to the REST API will require an Authorization header. This\nheader will hold authentication information using a custom scheme. This\nis what it should look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - An access token which grants access to the resource.\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" } ], "url": { "raw": "{{baseUrl}}/user-groups?fields=[object Object]&filters=[object Object],[object Object]&sortModels=[object Object],[object Object]&limit=", "host": [ "{{baseUrl}}" ], "path": [ "user-groups" ], "query": [ { "key": "fields", "value": "[object Object]" }, { "key": "filters", "value": "[object Object],[object Object]" }, { "key": "sortModels", "value": "[object Object],[object Object]" }, { "key": "limit", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "", "description": "The ETag." }, { "key": "Content-Language", "value": "", "description": "The preffered language of the user." }, { "key": "Content-Type", "value": "application/vnd.yellowfin.api-v1+json" } ], "cookie": [], "body": "{\n \"errorCode\": 401,\n \"reason\": \"INVALID_CREDENTIALS\",\n \"description\": \"Problem with the token or signature\"\n}" } ] }, { "name": "Create a new user group", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/vnd.yellowfin.api-v1+json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"groupName\": \"Test API Group 3\",\r\n \"groupDescription\": \"Created through the REST API for testing purposes\",\r\n \"groupStatus\": \"DRAFT\",\r\n \"isSecureGroup\": false\r\n}" }, "url": { "raw": "{{baseUrl}}/user-groups", "host": [ "{{baseUrl}}" ], "path": [ "user-groups" ] } }, "response": [] } ] }, { "name": "login-tokens", "item": [ { "name": "Login tokens for single sign on/off to the web application or javascript API", "event": [ { "listen": "test", "script": { "exec": [ "" ], "type": "text/javascript" } }, { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Accept", "value": "application/vnd.yellowfin.api-v1+json", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "Authorization", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}", "description": "(Required) Authorization header when creating an access token. This header will\nhold authentication information using a custom scheme. This is what it\nshould look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - A refresh token that was acquired before when the user was\nlogged in\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n\"signOnUser\": {\r\n\"userName\": \"admin@yellowfin.com.au\",\r\n\"password\": \"test\"\r\n},\r\n\"loginParameters\": [\r\n\"YFTOOLBAR=FALSE\",\r\n\"ENTRY=VIEWDASHBOARD\",\r\n\"HIDESIDENAV=TRUE\",\r\n\"HIDEHEADER=TRUE\"\r\n],\r\n\"noPassword\": false,\r\n\"customParameters\": \"Some custom integration value\"\r\n}" }, "url": { "raw": "{{baseUrl}}/login-tokens", "host": [ "{{baseUrl}}" ], "path": [ "login-tokens" ] } }, "response": [ { "name": "A new access token that can be used to access resources.", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/access-tokens", "host": [ "{{baseUrl}}" ], "path": [ "access-tokens" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "", "description": "The ETag." }, { "key": "Content-Type", "value": "application/vnd.yellowfin.api-v1+json" } ], "cookie": [], "body": "{\n \"securityToken\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJjbGllbnQiOiIxIiwicm9sZSI6IllGQURNSU4iLCJleHAiOjE1NTUzOTg4MTcsInRpIjoyMzQyMzQsImlhdCI6MTU1NTM5NzYxNywicGVyc29uIjoiNSJ9.nPcUTizWJM0uSFB5XO5E_UYI1HsaredjE5GRKM1FtPKmefcWlk23YtN8zCNXIFqyZS2Ah0bUDYYZvYwEyweFiQ\\n\",\n \"expiry\": 1200,\n \"_links\": {\n \"menu\": {\n \"href\": \"/api/menus/mobile-menu\",\n \"options\": [\n \"GET\"\n ]\n },\n \"new\": {\n \"href\": \"/api/access-tokens\",\n \"options\": [\n \"POST\"\n ]\n }\n }\n}" }, { "name": "An error encountered by the server, returned as a model with an error\ncode and a description.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Authorization header when creating an access token. This header will\nhold authentication information using a custom scheme. This is what it\nshould look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - A refresh token that was acquired before when the user was\nlogged in\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" }, { "key": "Accept", "value": "", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "Authorization", "value": "schema type not provided", "description": "(Required) Authorization header when creating an access token. This header will\nhold authentication information using a custom scheme. This is what it\nshould look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - A refresh token that was acquired before when the user was\nlogged in\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" } ], "url": { "raw": "{{baseUrl}}/access-tokens", "host": [ "{{baseUrl}}" ], "path": [ "access-tokens" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "ETag", "value": "", "description": "The ETag." }, { "key": "Content-Language", "value": "", "description": "The preffered language of the user." }, { "key": "Content-Type", "value": "application/vnd.yellowfin.api-v1+json" } ], "cookie": [], "body": "{\n \"errorCode\": 401,\n \"reason\": \"INVALID_CREDENTIALS\",\n \"description\": \"Problem with the token or signature\"\n}" } ] }, { "name": "Create an SSO login token without a valid access token", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/vnd.yellowfin.api-v1+json", "type": "text" }, { "key": "Authorization", "value": "YELLOWFIN ts={{ts}}, nonce=random", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n\"signOnUser\": {\r\n\"userName\": \"admin@yellowfin.com.au\",\r\n\"password\": \"test\"\r\n},\r\n\"loginParameters\": [\r\n\r\n\"ENTRY=BROWSE\"\r\n\r\n],\r\n\"noPassword\": false,\r\n\r\n\"adminUser\": {\r\n\"userName\": \"admin@yellowfin.com.au\",\r\n\"password\": \"test\"\r\n}\r\n\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rpc/login-tokens/create-sso-token", "host": [ "{{baseUrl}}" ], "path": [ "rpc", "login-tokens", "create-sso-token" ] } }, "response": [] } ] }, { "name": "Licence-management", "item": [ { "name": "Upload License", "event": [ { "listen": "test", "script": { "exec": [ "if (pm.response.code === 200) {", " var jsonData = pm.response.json();", " pm.collectionVariables.set(\"accesstoken\", jsonData.securityToken);", "}", "" ], "type": "text/javascript" } }, { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } } ], "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Accept", "value": "application/vnd.yellowfin.api-v1+json", "description": "(Required) The accept header for requests to the API. Contains version information." }, { "key": "Authorization", "value": "YELLOWFIN ts={{ts}}, nonce=random, token={{accesstoken}}", "description": "(Required) Authorization header when creating an access token. This header will\nhold authentication information using a custom scheme. This is what it\nshould look like for\n\nExample - YELLOWFIN ts=1556274125859, nonce=Or6Li06eKfRDEV,\ntoken=7Av1yDZZg3ARC5== signature=TleRkHWuqnzJ7H4Pt1Y==\n\n* YELLOWFIN – Custom Authentication scheme\n\n* ts – The number of milliseconds from epoch, on the client\n\n* nonce – A random UUID generated by the client. Must be unique for each\nrequest.\n\n* token - A refresh token that was acquired before when the user was\nlogged in\n\n* signature - to verify the source and integrity of a request. Refer\ndocumentation for how to construct this\n" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "formdata", "formdata": [ { "key": "newLicence", "type": "file", "src": [] } ] }, "url": { "raw": "{{baseUrl}}/rpc/licence-management/upload-licence", "host": [ "{{baseUrl}}" ], "path": [ "rpc", "licence-management", "upload-licence" ] } }, "response": [] } ] } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "var ts = new Date();", "pm.globals.set('ts', ts.getTime());" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ], "variable": [ { "key": "baseUrl", "value": "http://localhost:9696/api" }, { "key": "yfusername", "value": "admin@yellowfin.com.au" }, { "key": "yfpassword", "value": "test" }, { "key": "refreshtoken", "value": "" }, { "key": "accesstoken", "value": "" }, { "key": "yfclientOrgRef", "value": "YFDefault" } ] }