{ "info" : { "name" : "apidoc api", "schema" : "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description" : { "content" : "Host API documentation for applications providing REST APIs, facilitating the design of good resource first APIs." }, "version" : "0.0.5" }, "item" : [ { "name" : "applications", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey" ], "query" : [ { "key" : "name", "disabled" : true, "description" : { "content" : "The name of an application. Case in-sensitive. Exact match" } }, { "key" : "guid", "disabled" : true, "description" : { "content" : "The guid of an application. Exact match" } }, { "key" : "key", "disabled" : true, "description" : { "content" : "The key of an application. Case in-sensitive. Exact match" } }, { "key" : "has_version", "disabled" : true, "description" : { "content" : "If true, we return applications that have at least one version. If false, we return applications that have no versions in the system" } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "The organization key for which to search applications" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Search all applications. Results are always paginated." }, "header" : [ ] }, "name" : "GET /:orgKey", "description" : { "content" : "Search all applications. Results are always paginated." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - [application]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey" ], "query" : [ { "key" : "name", "disabled" : true, "description" : { "content" : "The name of an application. Case in-sensitive. Exact match" } }, { "key" : "guid", "disabled" : true, "description" : { "content" : "The guid of an application. Exact match" } }, { "key" : "key", "disabled" : true, "description" : { "content" : "The key of an application. Case in-sensitive. Exact match" } }, { "key" : "has_version", "disabled" : true, "description" : { "content" : "If true, we return applications that have at least one version. If false, we return applications that have no versions in the system" } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "The organization key for which to search applications" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Search all applications. Results are always paginated." }, "header" : [ ] }, "code" : 200 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Create an application." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"eb05908c0065\",\n \"key\" : \"ff965240e165\",\n \"description\" : \"41db1d9d4e38\",\n \"visibility\" : \"user\"\n}", "mode" : "raw" } }, "name" : "POST /:orgKey", "description" : { "content" : "Create an application." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - application", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Create an application." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"eb05908c0065\",\n \"key\" : \"ff965240e165\",\n \"description\" : \"41db1d9d4e38\",\n \"visibility\" : \"user\"\n}", "mode" : "raw" } }, "code" : 200 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Create an application." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"eb05908c0065\",\n \"key\" : \"ff965240e165\",\n \"description\" : \"41db1d9d4e38\",\n \"visibility\" : \"user\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"161035af0b4a\",\n \"message\" : \"9cb6b0637ec5\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "PUT", "description" : { "content" : "Updates an application." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"6fa870a470c9\",\n \"key\" : \"e57efdbff68d\",\n \"description\" : \"b183b4067679\",\n \"visibility\" : \"organization\"\n}", "mode" : "raw" } }, "name" : "PUT /:orgKey/:applicationKey", "description" : { "content" : "Updates an application." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"PUT requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - application", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "PUT", "description" : { "content" : "Updates an application." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"6fa870a470c9\",\n \"key\" : \"e57efdbff68d\",\n \"description\" : \"b183b4067679\",\n \"visibility\" : \"organization\"\n}", "mode" : "raw" } }, "code" : 200 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "PUT", "description" : { "content" : "Updates an application." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"6fa870a470c9\",\n \"key\" : \"e57efdbff68d\",\n \"description\" : \"b183b4067679\",\n \"visibility\" : \"organization\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"af293ef7b26e\",\n \"message\" : \"5b750689e702\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes a specific application and its associated versions." }, "header" : [ ] }, "name" : "DELETE /:orgKey/:applicationKey", "description" : { "content" : "Deletes a specific application and its associated versions." }, "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes a specific application and its associated versions." }, "header" : [ ] }, "code" : 204 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/move", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", "move" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Moves application to a new organization." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"org_key\" : \"7d82c4f39437\"\n}", "mode" : "raw" } }, "name" : "POST /:orgKey/:applicationKey/move", "description" : { "content" : "Moves application to a new organization." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - application", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/move", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", "move" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Moves application to a new organization." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"org_key\" : \"7d82c4f39437\"\n}", "mode" : "raw" } }, "code" : 200 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/move", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", "move" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Moves application to a new organization." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"org_key\" : \"7d82c4f39437\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"5d0f17db527c\",\n \"message\" : \"450a72d68397\"\n} ]", "code" : 409 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "attributes", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/attributes", "host" : [ "{{BASE_URL}}" ], "path" : [ "attributes" ], "query" : [ { "key" : "guid", "disabled" : true, "description" : { "content" : "Find the watch with this guid." } }, { "key" : "name", "disabled" : true, "description" : { "content" : "Find attributes with this name. Case in-sensitive. Exact match" } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Search all attributes. Results are always paginated." }, "header" : [ ] }, "name" : "GET /attributes", "description" : { "content" : "Search all attributes. Results are always paginated." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - [attribute]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/attributes", "host" : [ "{{BASE_URL}}" ], "path" : [ "attributes" ], "query" : [ { "key" : "guid", "disabled" : true, "description" : { "content" : "Find the watch with this guid." } }, { "key" : "name", "disabled" : true, "description" : { "content" : "Find attributes with this name. Case in-sensitive. Exact match" } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Search all attributes. Results are always paginated." }, "header" : [ ] }, "code" : 200 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/attributes/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "attributes", ":name" ], "query" : [ ], "variable" : [ { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns the attribute with this name." }, "header" : [ ] }, "name" : "GET /attributes/:name", "description" : { "content" : "Returns the attribute with this name." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - attribute", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/attributes/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "attributes", ":name" ], "query" : [ ], "variable" : [ { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns the attribute with this name." }, "header" : [ ] }, "code" : 200 }, { "name" : "Example 404 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/attributes/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "attributes", ":name" ], "query" : [ ], "variable" : [ { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns the attribute with this name." }, "header" : [ ] }, "code" : 404 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/attributes", "host" : [ "{{BASE_URL}}" ], "path" : [ "attributes" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new attribute." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"2e1b9c701dcb\",\n \"description\" : \"41caa798e512\"\n}", "mode" : "raw" } }, "name" : "POST /attributes", "description" : { "content" : "Create a new attribute." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 201 - attribute", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/attributes", "host" : [ "{{BASE_URL}}" ], "path" : [ "attributes" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new attribute." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"2e1b9c701dcb\",\n \"description\" : \"41caa798e512\"\n}", "mode" : "raw" } }, "code" : 201 }, { "name" : "Example 401 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/attributes", "host" : [ "{{BASE_URL}}" ], "path" : [ "attributes" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new attribute." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"2e1b9c701dcb\",\n \"description\" : \"41caa798e512\"\n}", "mode" : "raw" } }, "code" : 401 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/attributes", "host" : [ "{{BASE_URL}}" ], "path" : [ "attributes" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new attribute." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"2e1b9c701dcb\",\n \"description\" : \"41caa798e512\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"cee6743445ce\",\n \"message\" : \"ad87bec4b69b\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/attributes/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "attributes", ":name" ], "query" : [ ], "variable" : [ { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes the attribute with this name. Only the user who created an attribute can delete it." }, "header" : [ ] }, "name" : "DELETE /attributes/:name", "description" : { "content" : "Deletes the attribute with this name. Only the user who created an attribute can delete it." }, "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/attributes/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "attributes", ":name" ], "query" : [ ], "variable" : [ { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes the attribute with this name. Only the user who created an attribute can delete it." }, "header" : [ ] }, "code" : 204 }, { "name" : "Example 401 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/attributes/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "attributes", ":name" ], "query" : [ ], "variable" : [ { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes the attribute with this name. Only the user who created an attribute can delete it." }, "header" : [ ] }, "code" : 401 }, { "name" : "Example 404 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/attributes/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "attributes", ":name" ], "query" : [ ], "variable" : [ { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes the attribute with this name. Only the user who created an attribute can delete it." }, "header" : [ ] }, "code" : 404 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "changes", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/changes", "host" : [ "{{BASE_URL}}" ], "path" : [ "changes" ], "query" : [ { "key" : "org_key", "disabled" : true, "description" : { "content" : "Filter changes to those made for the organization with this key." } }, { "key" : "application_key", "disabled" : true, "description" : { "content" : "Filter changes to those made for the application with this key." } }, { "key" : "from", "value" : "0.1.3", "disabled" : true, "description" : { "content" : "Filter changes to those made from this version." } }, { "key" : "to", "value" : "0.1.4", "disabled" : true, "description" : { "content" : "Filter changes to those made to this version." } }, { "key" : "type", "value" : "breaking or non_breaking", "disabled" : true, "description" : { "content" : "The type of diff to return." } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "header" : [ ] }, "name" : "GET /changes", "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - [change]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/changes", "host" : [ "{{BASE_URL}}" ], "path" : [ "changes" ], "query" : [ { "key" : "org_key", "disabled" : true, "description" : { "content" : "Filter changes to those made for the organization with this key." } }, { "key" : "application_key", "disabled" : true, "description" : { "content" : "Filter changes to those made for the application with this key." } }, { "key" : "from", "value" : "0.1.3", "disabled" : true, "description" : { "content" : "Filter changes to those made from this version." } }, { "key" : "to", "value" : "0.1.4", "disabled" : true, "description" : { "content" : "Filter changes to those made to this version." } }, { "key" : "type", "value" : "breaking or non_breaking", "disabled" : true, "description" : { "content" : "The type of diff to return." } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "header" : [ ] }, "code" : 200 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "code", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version/:generatorKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version", ":generatorKey" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "The organization key for which to generate code" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "The application key for which to generate code" }, "disabled" : false }, { "key" : "version", "value" : "{{version}}", "description" : { "content" : "The version of this application. Can be 'latest'" }, "disabled" : false }, { "key" : "generatorKey", "value" : "{{generatorKey}}", "description" : { "content" : "The key of the generator to invoke" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Generate code for a specific version of an application." }, "header" : [ ] }, "name" : "GET /:orgKey/:applicationKey/:version/:generatorKey", "description" : { "content" : "Generate code for a specific version of an application." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - code", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version/:generatorKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version", ":generatorKey" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "The organization key for which to generate code" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "The application key for which to generate code" }, "disabled" : false }, { "key" : "version", "value" : "{{version}}", "description" : { "content" : "The version of this application. Can be 'latest'" }, "disabled" : false }, { "key" : "generatorKey", "value" : "{{generatorKey}}", "description" : { "content" : "The key of the generator to invoke" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Generate code for a specific version of an application." }, "header" : [ ] }, "code" : 200 }, { "name" : "Example 404 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version/:generatorKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version", ":generatorKey" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "The organization key for which to generate code" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "The application key for which to generate code" }, "disabled" : false }, { "key" : "version", "value" : "{{version}}", "description" : { "content" : "The version of this application. Can be 'latest'" }, "disabled" : false }, { "key" : "generatorKey", "value" : "{{generatorKey}}", "description" : { "content" : "The key of the generator to invoke" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Generate code for a specific version of an application." }, "header" : [ ] }, "code" : 404 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version/:generatorKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version", ":generatorKey" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "The organization key for which to generate code" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "The application key for which to generate code" }, "disabled" : false }, { "key" : "version", "value" : "{{version}}", "description" : { "content" : "The version of this application. Can be 'latest'" }, "disabled" : false }, { "key" : "generatorKey", "value" : "{{generatorKey}}", "description" : { "content" : "The key of the generator to invoke" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Generate code for a specific version of an application." }, "header" : [ ] }, "body" : "[ {\n \"code\" : \"e4dc72db5383\",\n \"message\" : \"18712f8b0701\"\n} ]", "code" : 409 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "healthchecks", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/_internal_/healthcheck", "host" : [ "{{BASE_URL}}" ], "path" : [ "_internal_", "healthcheck" ], "query" : [ ], "variable" : [ ] }, "method" : "GET", "header" : [ ] }, "name" : "GET /_internal_/healthcheck", "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - healthcheck", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/_internal_/healthcheck", "host" : [ "{{BASE_URL}}" ], "path" : [ "_internal_", "healthcheck" ], "query" : [ ], "variable" : [ ] }, "method" : "GET", "header" : [ ] }, "code" : 200 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/_internal_/migrate", "host" : [ "{{BASE_URL}}" ], "path" : [ "_internal_", "migrate" ], "query" : [ ], "variable" : [ ] }, "method" : "GET", "header" : [ ] }, "name" : "GET /_internal_/migrate", "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - map[string]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/_internal_/migrate", "host" : [ "{{BASE_URL}}" ], "path" : [ "_internal_", "migrate" ], "query" : [ ], "variable" : [ ] }, "method" : "GET", "header" : [ ] }, "body" : "{\n \"foo\" : \"8abc4f71cf40\"\n}", "code" : 200 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "domains", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/domains/:orgKey", "host" : [ "{{BASE_URL}}" ], "path" : [ "domains", ":orgKey" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Add a domain to this organization" }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"www.apidoc.me\"\n}", "mode" : "raw" } }, "name" : "POST /domains/:orgKey", "description" : { "content" : "Add a domain to this organization" }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - domain", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/domains/:orgKey", "host" : [ "{{BASE_URL}}" ], "path" : [ "domains", ":orgKey" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Add a domain to this organization" }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"www.apidoc.me\"\n}", "mode" : "raw" } }, "body" : "{\n \"name\" : \"www.apidoc.me\"\n}", "code" : 200 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/domains/:orgKey", "host" : [ "{{BASE_URL}}" ], "path" : [ "domains", ":orgKey" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Add a domain to this organization" }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"www.apidoc.me\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"e86ecc83a041\",\n \"message\" : \"7b53870a6f8a\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/domains/:orgKey/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "domains", ":orgKey", ":name" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Remove this domain from this organization" }, "header" : [ ] }, "name" : "DELETE /domains/:orgKey/:name", "description" : { "content" : "Remove this domain from this organization" }, "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/domains/:orgKey/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "domains", ":orgKey", ":name" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Remove this domain from this organization" }, "header" : [ ] }, "code" : 204 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "email_verification_confirmation_forms", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/email_verification_confirmations", "host" : [ "{{BASE_URL}}" ], "path" : [ "email_verification_confirmations" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Validate an email address using a token." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"token\" : \"cb3f7fea114d\"\n}", "mode" : "raw" } }, "name" : "POST /email_verification_confirmations", "description" : { "content" : "Validate an email address using a token." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/email_verification_confirmations", "host" : [ "{{BASE_URL}}" ], "path" : [ "email_verification_confirmations" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Validate an email address using a token." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"token\" : \"cb3f7fea114d\"\n}", "mode" : "raw" } }, "code" : 204 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/email_verification_confirmations", "host" : [ "{{BASE_URL}}" ], "path" : [ "email_verification_confirmations" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Validate an email address using a token." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"token\" : \"cb3f7fea114d\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"a259f1173347\",\n \"message\" : \"1ef495337d76\"\n} ]", "code" : 409 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "generator_services", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/generator_services", "host" : [ "{{BASE_URL}}" ], "path" : [ "generator_services" ], "query" : [ { "key" : "guid", "disabled" : true, "description" : { "content" : "Type: uuid | Required: false" } }, { "key" : "uri", "disabled" : true, "description" : { "content" : "Type: string | Required: false" } }, { "key" : "generator_key", "disabled" : true, "description" : { "content" : "Type: string | Required: false" } }, { "key" : "limit", "value" : "100", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "List all generator services" }, "header" : [ ] }, "name" : "GET /generator_services", "description" : { "content" : "List all generator services" }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - [generator_service]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/generator_services", "host" : [ "{{BASE_URL}}" ], "path" : [ "generator_services" ], "query" : [ { "key" : "guid", "disabled" : true, "description" : { "content" : "Type: uuid | Required: false" } }, { "key" : "uri", "disabled" : true, "description" : { "content" : "Type: string | Required: false" } }, { "key" : "generator_key", "disabled" : true, "description" : { "content" : "Type: string | Required: false" } }, { "key" : "limit", "value" : "100", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "List all generator services" }, "header" : [ ] }, "code" : 200 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/generator_services/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "generator_services", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "header" : [ ] }, "name" : "GET /generator_services/:guid", "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - generator_service", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/generator_services/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "generator_services", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "header" : [ ] }, "code" : 200 }, { "name" : "Example 404 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/generator_services/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "generator_services", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "header" : [ ] }, "code" : 404 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/generator_services", "host" : [ "{{BASE_URL}}" ], "path" : [ "generator_services" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"uri\" : \"f5166f0a262f\"\n}", "mode" : "raw" } }, "name" : "POST /generator_services", "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - generator_service", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/generator_services", "host" : [ "{{BASE_URL}}" ], "path" : [ "generator_services" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"uri\" : \"f5166f0a262f\"\n}", "mode" : "raw" } }, "code" : 200 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/generator_services", "host" : [ "{{BASE_URL}}" ], "path" : [ "generator_services" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"uri\" : \"f5166f0a262f\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"7420b06c9927\",\n \"message\" : \"a37d9b6ca9ba\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/generator_services/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "generator_services", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes a generator service." }, "header" : [ ] }, "name" : "DELETE /generator_services/:guid", "description" : { "content" : "Deletes a generator service." }, "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/generator_services/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "generator_services", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes a generator service." }, "header" : [ ] }, "code" : 204 }, { "name" : "Example 404 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/generator_services/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "generator_services", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes a generator service." }, "header" : [ ] }, "code" : 404 }, { "name" : "Example 403 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/generator_services/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "generator_services", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes a generator service." }, "header" : [ ] }, "code" : 403 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "generator_with_services", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/generators", "host" : [ "{{BASE_URL}}" ], "path" : [ "generators" ], "query" : [ { "key" : "guid", "disabled" : true, "description" : { "content" : "Filter to generator with this guid" } }, { "key" : "service_guid", "disabled" : true, "description" : { "content" : "Filter to generator from this service" } }, { "key" : "service_uri", "disabled" : true, "description" : { "content" : "Filter to generator from this service URI" } }, { "key" : "attribute_name", "disabled" : true, "description" : { "content" : "Filter to generators that use this attribute" } }, { "key" : "key", "disabled" : true, "description" : { "content" : "Filter to generator with this key" } }, { "key" : "limit", "value" : "100", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "List all available generators" }, "header" : [ ] }, "name" : "GET /generators", "description" : { "content" : "List all available generators" }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - [generator_with_service]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/generators", "host" : [ "{{BASE_URL}}" ], "path" : [ "generators" ], "query" : [ { "key" : "guid", "disabled" : true, "description" : { "content" : "Filter to generator with this guid" } }, { "key" : "service_guid", "disabled" : true, "description" : { "content" : "Filter to generator from this service" } }, { "key" : "service_uri", "disabled" : true, "description" : { "content" : "Filter to generator from this service URI" } }, { "key" : "attribute_name", "disabled" : true, "description" : { "content" : "Filter to generators that use this attribute" } }, { "key" : "key", "disabled" : true, "description" : { "content" : "Filter to generator with this key" } }, { "key" : "limit", "value" : "100", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "List all available generators" }, "header" : [ ] }, "code" : 200 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/generators/:key", "host" : [ "{{BASE_URL}}" ], "path" : [ "generators", ":key" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "GET", "header" : [ ] }, "name" : "GET /generators/:key", "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - generator_with_service", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/generators/:key", "host" : [ "{{BASE_URL}}" ], "path" : [ "generators", ":key" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "GET", "header" : [ ] }, "code" : 200 }, { "name" : "Example 404 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/generators/:key", "host" : [ "{{BASE_URL}}" ], "path" : [ "generators", ":key" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "GET", "header" : [ ] }, "code" : 404 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "items", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/items", "host" : [ "{{BASE_URL}}" ], "path" : [ "items" ], "query" : [ { "key" : "q", "disabled" : true, "description" : { "content" : "The search query. At the moment, we do case insensitive exact match search." } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "header" : [ ] }, "name" : "GET /items", "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - [item]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/items", "host" : [ "{{BASE_URL}}" ], "path" : [ "items" ], "query" : [ { "key" : "q", "disabled" : true, "description" : { "content" : "The search query. At the moment, we do case insensitive exact match search." } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "header" : [ ] }, "code" : 200 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/items/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "items", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "header" : [ ] }, "name" : "GET /items/:guid", "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - item", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/items/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "items", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "header" : [ ] }, "code" : 200 }, { "name" : "Example 404 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/items/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "items", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "header" : [ ] }, "code" : 404 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "memberships", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/memberships", "host" : [ "{{BASE_URL}}" ], "path" : [ "memberships" ], "query" : [ { "key" : "org_guid", "disabled" : true, "description" : { "content" : "Type: uuid | Required: false" } }, { "key" : "org_key", "disabled" : true, "description" : { "content" : "Type: string | Required: false" } }, { "key" : "user_guid", "disabled" : true, "description" : { "content" : "Type: uuid | Required: false" } }, { "key" : "role", "disabled" : true, "description" : { "content" : "Type: string | Required: false" } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Search all memberships. Results are always paginated." }, "header" : [ ] }, "name" : "GET /memberships", "description" : { "content" : "Search all memberships. Results are always paginated." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - [membership]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/memberships", "host" : [ "{{BASE_URL}}" ], "path" : [ "memberships" ], "query" : [ { "key" : "org_guid", "disabled" : true, "description" : { "content" : "Type: uuid | Required: false" } }, { "key" : "org_key", "disabled" : true, "description" : { "content" : "Type: string | Required: false" } }, { "key" : "user_guid", "disabled" : true, "description" : { "content" : "Type: uuid | Required: false" } }, { "key" : "role", "disabled" : true, "description" : { "content" : "Type: string | Required: false" } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Search all memberships. Results are always paginated." }, "header" : [ ] }, "code" : 200 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/memberships/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "memberships", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "header" : [ ] }, "name" : "GET /memberships/:guid", "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - membership", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/memberships/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "memberships", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "header" : [ ] }, "code" : 200 }, { "name" : "Example 404 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/memberships/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "memberships", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "header" : [ ] }, "code" : 404 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/memberships/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "memberships", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "header" : [ ] }, "name" : "DELETE /memberships/:guid", "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/memberships/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "memberships", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "header" : [ ] }, "code" : 204 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "membership_requests", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/membership_requests", "host" : [ "{{BASE_URL}}" ], "path" : [ "membership_requests" ], "query" : [ { "key" : "org_guid", "disabled" : true, "description" : { "content" : "Type: uuid | Required: false" } }, { "key" : "org_key", "disabled" : true, "description" : { "content" : "Type: string | Required: false" } }, { "key" : "user_guid", "disabled" : true, "description" : { "content" : "Type: uuid | Required: false" } }, { "key" : "role", "disabled" : true, "description" : { "content" : "Type: string | Required: false" } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Search all membership requests. Results are always paginated." }, "header" : [ ] }, "name" : "GET /membership_requests", "description" : { "content" : "Search all membership requests. Results are always paginated." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - [membership_request]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/membership_requests", "host" : [ "{{BASE_URL}}" ], "path" : [ "membership_requests" ], "query" : [ { "key" : "org_guid", "disabled" : true, "description" : { "content" : "Type: uuid | Required: false" } }, { "key" : "org_key", "disabled" : true, "description" : { "content" : "Type: string | Required: false" } }, { "key" : "user_guid", "disabled" : true, "description" : { "content" : "Type: uuid | Required: false" } }, { "key" : "role", "disabled" : true, "description" : { "content" : "Type: string | Required: false" } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Search all membership requests. Results are always paginated." }, "header" : [ ] }, "code" : 200 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/membership_requests", "host" : [ "{{BASE_URL}}" ], "path" : [ "membership_requests" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a membership request" }, "header" : [ ] }, "name" : "POST /membership_requests", "description" : { "content" : "Create a membership request" }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - membership_request", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/membership_requests", "host" : [ "{{BASE_URL}}" ], "path" : [ "membership_requests" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a membership request" }, "header" : [ ] }, "code" : 200 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/membership_requests", "host" : [ "{{BASE_URL}}" ], "path" : [ "membership_requests" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a membership request" }, "header" : [ ] }, "body" : "[ {\n \"code\" : \"64cca95dcf5c\",\n \"message\" : \"908e839eb1f4\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/membership_requests/:guid/accept", "host" : [ "{{BASE_URL}}" ], "path" : [ "membership_requests", ":guid", "accept" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Accepts this membership request. User will become a member of the specified organization." }, "header" : [ ] }, "name" : "POST /membership_requests/:guid/accept", "description" : { "content" : "Accepts this membership request. User will become a member of the specified organization." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/membership_requests/:guid/accept", "host" : [ "{{BASE_URL}}" ], "path" : [ "membership_requests", ":guid", "accept" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Accepts this membership request. User will become a member of the specified organization." }, "header" : [ ] }, "code" : 204 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/membership_requests/:guid/accept", "host" : [ "{{BASE_URL}}" ], "path" : [ "membership_requests", ":guid", "accept" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Accepts this membership request. User will become a member of the specified organization." }, "header" : [ ] }, "body" : "[ {\n \"code\" : \"e72b6cd04079\",\n \"message\" : \"341a25ca04a8\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/membership_requests/:guid/decline", "host" : [ "{{BASE_URL}}" ], "path" : [ "membership_requests", ":guid", "decline" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Declines this membership request. User will NOT become a member of the specified organization." }, "header" : [ ] }, "name" : "POST /membership_requests/:guid/decline", "description" : { "content" : "Declines this membership request. User will NOT become a member of the specified organization." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/membership_requests/:guid/decline", "host" : [ "{{BASE_URL}}" ], "path" : [ "membership_requests", ":guid", "decline" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Declines this membership request. User will NOT become a member of the specified organization." }, "header" : [ ] }, "code" : 204 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/membership_requests/:guid/decline", "host" : [ "{{BASE_URL}}" ], "path" : [ "membership_requests", ":guid", "decline" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Declines this membership request. User will NOT become a member of the specified organization." }, "header" : [ ] }, "body" : "[ {\n \"code\" : \"559b15d1374a\",\n \"message\" : \"b95930e871a9\"\n} ]", "code" : 409 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "organizations", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/organizations", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations" ], "query" : [ { "key" : "guid", "disabled" : true, "description" : { "content" : "Finds the organization with this guid, if any" } }, { "key" : "user_guid", "disabled" : true, "description" : { "content" : "If specified, restricts to organizations that this user is specifically a member of (e.g. will exclude public organizations with which the user does not have a direct membership)." } }, { "key" : "key", "disabled" : true, "description" : { "content" : "Find organizations with this key. Case in-sensitive. Exact match" } }, { "key" : "name", "disabled" : true, "description" : { "content" : "Find organizations with this name. Case in-sensitive. Exact match" } }, { "key" : "namespace", "disabled" : true, "description" : { "content" : "Find organizations with this namespace. Case in-sensitive. Exact match" } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Search all organizations. Results are always paginated." }, "header" : [ ] }, "name" : "GET /organizations", "description" : { "content" : "Search all organizations. Results are always paginated." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - [organization]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/organizations", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations" ], "query" : [ { "key" : "guid", "disabled" : true, "description" : { "content" : "Finds the organization with this guid, if any" } }, { "key" : "user_guid", "disabled" : true, "description" : { "content" : "If specified, restricts to organizations that this user is specifically a member of (e.g. will exclude public organizations with which the user does not have a direct membership)." } }, { "key" : "key", "disabled" : true, "description" : { "content" : "Find organizations with this key. Case in-sensitive. Exact match" } }, { "key" : "name", "disabled" : true, "description" : { "content" : "Find organizations with this name. Case in-sensitive. Exact match" } }, { "key" : "namespace", "disabled" : true, "description" : { "content" : "Find organizations with this namespace. Case in-sensitive. Exact match" } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Search all organizations. Results are always paginated." }, "header" : [ ] }, "code" : 200 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns the organization with this key." }, "header" : [ ] }, "name" : "GET /organizations/:key", "description" : { "content" : "Returns the organization with this key." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - organization", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns the organization with this key." }, "header" : [ ] }, "code" : 200 }, { "name" : "Example 404 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns the organization with this key." }, "header" : [ ] }, "code" : 404 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/organizations", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new organization." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"aca3b00f7a88\",\n \"domains\" : [ \"672761a44227\" ],\n \"key\" : \"5e3e06dbd697\",\n \"visibility\" : \"organization\",\n \"namespace\" : \"com.bryzek\"\n}", "mode" : "raw" } }, "name" : "POST /organizations", "description" : { "content" : "Create a new organization." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - organization", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/organizations", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new organization." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"aca3b00f7a88\",\n \"domains\" : [ \"672761a44227\" ],\n \"key\" : \"5e3e06dbd697\",\n \"visibility\" : \"organization\",\n \"namespace\" : \"com.bryzek\"\n}", "mode" : "raw" } }, "code" : 200 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/organizations", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new organization." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"aca3b00f7a88\",\n \"domains\" : [ \"672761a44227\" ],\n \"key\" : \"5e3e06dbd697\",\n \"visibility\" : \"organization\",\n \"namespace\" : \"com.bryzek\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"19a56b9361c4\",\n \"message\" : \"d35f1a289d53\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "PUT", "description" : { "content" : "Update an organization." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"1ba665b08553\",\n \"domains\" : [ \"1cdd644bc39a\" ],\n \"key\" : \"1a65000689f3\",\n \"visibility\" : \"organization\",\n \"namespace\" : \"com.bryzek\"\n}", "mode" : "raw" } }, "name" : "PUT /organizations/:key", "description" : { "content" : "Update an organization." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"PUT requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - organization", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "PUT", "description" : { "content" : "Update an organization." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"1ba665b08553\",\n \"domains\" : [ \"1cdd644bc39a\" ],\n \"key\" : \"1a65000689f3\",\n \"visibility\" : \"organization\",\n \"namespace\" : \"com.bryzek\"\n}", "mode" : "raw" } }, "code" : 200 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "PUT", "description" : { "content" : "Update an organization." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"1ba665b08553\",\n \"domains\" : [ \"1cdd644bc39a\" ],\n \"key\" : \"1a65000689f3\",\n \"visibility\" : \"organization\",\n \"namespace\" : \"com.bryzek\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"5ceda47f1864\",\n \"message\" : \"8c1fea9ca0fe\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes an organization and all of its associated applications." }, "header" : [ ] }, "name" : "DELETE /organizations/:key", "description" : { "content" : "Deletes an organization and all of its associated applications." }, "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes an organization and all of its associated applications." }, "header" : [ ] }, "code" : 204 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key/attributes", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key", "attributes" ], "query" : [ { "key" : "name", "disabled" : true, "description" : { "content" : "Find the values for the attribute with this name." } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns all attribute values for this organization. Results are always paginated." }, "header" : [ ] }, "name" : "GET /organizations/:key/attributes", "description" : { "content" : "Returns all attribute values for this organization. Results are always paginated." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - [attribute_value]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key/attributes", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key", "attributes" ], "query" : [ { "key" : "name", "disabled" : true, "description" : { "content" : "Find the values for the attribute with this name." } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns all attribute values for this organization. Results are always paginated." }, "header" : [ ] }, "code" : 200 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key/attributes/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key", "attributes", ":name" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns the attribute value with this name." }, "header" : [ ] }, "name" : "GET /organizations/:key/attributes/:name", "description" : { "content" : "Returns the attribute value with this name." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - attribute_value", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key/attributes/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key", "attributes", ":name" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns the attribute value with this name." }, "header" : [ ] }, "code" : 200 }, { "name" : "Example 404 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key/attributes/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key", "attributes", ":name" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns the attribute value with this name." }, "header" : [ ] }, "code" : 404 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key/attributes/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key", "attributes", ":name" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "PUT", "description" : { "content" : "Create or update a new attribute value." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"value\" : \"a1efea3cab33\"\n}", "mode" : "raw" } }, "name" : "PUT /organizations/:key/attributes/:name", "description" : { "content" : "Create or update a new attribute value." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"PUT requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - attribute_value", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key/attributes/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key", "attributes", ":name" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "PUT", "description" : { "content" : "Create or update a new attribute value." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"value\" : \"a1efea3cab33\"\n}", "mode" : "raw" } }, "code" : 200 }, { "name" : "Example 201 - attribute_value", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key/attributes/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key", "attributes", ":name" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "PUT", "description" : { "content" : "Create or update a new attribute value." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"value\" : \"a1efea3cab33\"\n}", "mode" : "raw" } }, "code" : 201 }, { "name" : "Example 404 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key/attributes/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key", "attributes", ":name" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "PUT", "description" : { "content" : "Create or update a new attribute value." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"value\" : \"a1efea3cab33\"\n}", "mode" : "raw" } }, "code" : 404 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key/attributes/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key", "attributes", ":name" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "PUT", "description" : { "content" : "Create or update a new attribute value." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"value\" : \"a1efea3cab33\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"acc19f5666e3\",\n \"message\" : \"9e2d503e8eed\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key/attributes/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key", "attributes", ":name" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes the attribute value with the specified name. Only the user who created an attribute value can delete it." }, "header" : [ ] }, "name" : "DELETE /organizations/:key/attributes/:name", "description" : { "content" : "Deletes the attribute value with the specified name. Only the user who created an attribute value can delete it." }, "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key/attributes/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key", "attributes", ":name" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes the attribute value with the specified name. Only the user who created an attribute value can delete it." }, "header" : [ ] }, "code" : 204 }, { "name" : "Example 401 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key/attributes/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key", "attributes", ":name" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes the attribute value with the specified name. Only the user who created an attribute value can delete it." }, "header" : [ ] }, "code" : 401 }, { "name" : "Example 404 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key/attributes/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key", "attributes", ":name" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes the attribute value with the specified name. Only the user who created an attribute value can delete it." }, "header" : [ ] }, "code" : 404 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "password_resets", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/password_resets", "host" : [ "{{BASE_URL}}" ], "path" : [ "password_resets" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Change the password for this token. If the token is invalid, has been used, or otherwise no longer can be applied, errors will be returned as 409s. A 204 represents that the user has successfully changed their password." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"token\" : \"c069368c5332\",\n \"password\" : \"146cbb5b4e24\"\n}", "mode" : "raw" } }, "name" : "POST /password_resets", "description" : { "content" : "Change the password for this token. If the token is invalid, has been used, or otherwise no longer can be applied, errors will be returned as 409s. A 204 represents that the user has successfully changed their password." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - password_reset_success", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/password_resets", "host" : [ "{{BASE_URL}}" ], "path" : [ "password_resets" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Change the password for this token. If the token is invalid, has been used, or otherwise no longer can be applied, errors will be returned as 409s. A 204 represents that the user has successfully changed their password." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"token\" : \"c069368c5332\",\n \"password\" : \"146cbb5b4e24\"\n}", "mode" : "raw" } }, "body" : "{\n \"user_guid\" : \"d1af45b8-e677-4c2e-9c7b-51a9bd1c3801\"\n}", "code" : 200 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/password_resets", "host" : [ "{{BASE_URL}}" ], "path" : [ "password_resets" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Change the password for this token. If the token is invalid, has been used, or otherwise no longer can be applied, errors will be returned as 409s. A 204 represents that the user has successfully changed their password." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"token\" : \"c069368c5332\",\n \"password\" : \"146cbb5b4e24\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"9c1790431f11\",\n \"message\" : \"55d89ad04032\"\n} ]", "code" : 409 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "password_reset_requests", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/password_reset_requests", "host" : [ "{{BASE_URL}}" ], "path" : [ "password_reset_requests" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new password reset. This will send the user an email with a link to reset their password." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"email\" : \"4f46c2cbe3aa\"\n}", "mode" : "raw" } }, "name" : "POST /password_reset_requests", "description" : { "content" : "Create a new password reset. This will send the user an email with a link to reset their password." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/password_reset_requests", "host" : [ "{{BASE_URL}}" ], "path" : [ "password_reset_requests" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new password reset. This will send the user an email with a link to reset their password." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"email\" : \"4f46c2cbe3aa\"\n}", "mode" : "raw" } }, "code" : 204 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/password_reset_requests", "host" : [ "{{BASE_URL}}" ], "path" : [ "password_reset_requests" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new password reset. This will send the user an email with a link to reset their password." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"email\" : \"4f46c2cbe3aa\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"a3706d839963\",\n \"message\" : \"79939a211ab5\"\n} ]", "code" : 409 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "subscriptions", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/subscriptions", "host" : [ "{{BASE_URL}}" ], "path" : [ "subscriptions" ], "query" : [ { "key" : "guid", "disabled" : true, "description" : { "content" : "Find the subscription with this guid." } }, { "key" : "organization_key", "disabled" : true, "description" : { "content" : "Find subscriptions for this organization." } }, { "key" : "user_guid", "disabled" : true, "description" : { "content" : "Find subscriptions for this user." } }, { "key" : "publication", "disabled" : true, "description" : { "content" : "Find subscriptions for this publication." } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Search subscriptions. Always paginated." }, "header" : [ ] }, "name" : "GET /subscriptions", "description" : { "content" : "Search subscriptions. Always paginated." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - [subscription]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/subscriptions", "host" : [ "{{BASE_URL}}" ], "path" : [ "subscriptions" ], "query" : [ { "key" : "guid", "disabled" : true, "description" : { "content" : "Find the subscription with this guid." } }, { "key" : "organization_key", "disabled" : true, "description" : { "content" : "Find subscriptions for this organization." } }, { "key" : "user_guid", "disabled" : true, "description" : { "content" : "Find subscriptions for this user." } }, { "key" : "publication", "disabled" : true, "description" : { "content" : "Find subscriptions for this publication." } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Search subscriptions. Always paginated." }, "header" : [ ] }, "code" : 200 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/subscriptions/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "subscriptions", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns information about a specific subscription." }, "header" : [ ] }, "name" : "GET /subscriptions/:guid", "description" : { "content" : "Returns information about a specific subscription." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - subscription", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/subscriptions/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "subscriptions", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns information about a specific subscription." }, "header" : [ ] }, "code" : 200 }, { "name" : "Example 404 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/subscriptions/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "subscriptions", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns information about a specific subscription." }, "header" : [ ] }, "code" : 404 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/subscriptions", "host" : [ "{{BASE_URL}}" ], "path" : [ "subscriptions" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new subscription." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"organization_key\" : \"1d763626979b\",\n \"user_guid\" : \"12c66283-feb9-40d2-b2d8-c807110d945a\",\n \"publication\" : \"versions.create\"\n}", "mode" : "raw" } }, "name" : "POST /subscriptions", "description" : { "content" : "Create a new subscription." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 201 - subscription", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/subscriptions", "host" : [ "{{BASE_URL}}" ], "path" : [ "subscriptions" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new subscription." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"organization_key\" : \"1d763626979b\",\n \"user_guid\" : \"12c66283-feb9-40d2-b2d8-c807110d945a\",\n \"publication\" : \"versions.create\"\n}", "mode" : "raw" } }, "code" : 201 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/subscriptions", "host" : [ "{{BASE_URL}}" ], "path" : [ "subscriptions" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new subscription." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"organization_key\" : \"1d763626979b\",\n \"user_guid\" : \"12c66283-feb9-40d2-b2d8-c807110d945a\",\n \"publication\" : \"versions.create\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"574135ce78e4\",\n \"message\" : \"696fbfbf6f56\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/subscriptions/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "subscriptions", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "header" : [ ] }, "name" : "DELETE /subscriptions/:guid", "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/subscriptions/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "subscriptions", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "header" : [ ] }, "code" : 204 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "tokens", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/tokens/users/:user_guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "tokens", "users", ":user_guid" ], "query" : [ { "key" : "guid", "disabled" : true, "description" : { "content" : "Type: uuid | Required: false" } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ { "key" : "user_guid", "value" : "{{user_guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "header" : [ ] }, "name" : "GET /tokens/users/:user_guid", "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - [token]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/tokens/users/:user_guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "tokens", "users", ":user_guid" ], "query" : [ { "key" : "guid", "disabled" : true, "description" : { "content" : "Type: uuid | Required: false" } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ { "key" : "user_guid", "value" : "{{user_guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "header" : [ ] }, "code" : 200 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/tokens/:guid/cleartext", "host" : [ "{{BASE_URL}}" ], "path" : [ "tokens", ":guid", "cleartext" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Used to fetch the clear text token." }, "header" : [ ] }, "name" : "GET /tokens/:guid/cleartext", "description" : { "content" : "Used to fetch the clear text token." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - cleartext_token", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/tokens/:guid/cleartext", "host" : [ "{{BASE_URL}}" ], "path" : [ "tokens", ":guid", "cleartext" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Used to fetch the clear text token." }, "header" : [ ] }, "body" : "{\n \"token\" : \"2b18ad57d734\"\n}", "code" : 200 }, { "name" : "Example 404 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/tokens/:guid/cleartext", "host" : [ "{{BASE_URL}}" ], "path" : [ "tokens", ":guid", "cleartext" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Used to fetch the clear text token." }, "header" : [ ] }, "code" : 404 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/tokens", "host" : [ "{{BASE_URL}}" ], "path" : [ "tokens" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new API token for this user" }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"user_guid\" : \"8df5d7a6-37ca-4ed4-80b4-e93eed273037\",\n \"description\" : \"b77a7bdb1c8d\"\n}", "mode" : "raw" } }, "name" : "POST /tokens", "description" : { "content" : "Create a new API token for this user" }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 201 - token", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/tokens", "host" : [ "{{BASE_URL}}" ], "path" : [ "tokens" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new API token for this user" }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"user_guid\" : \"8df5d7a6-37ca-4ed4-80b4-e93eed273037\",\n \"description\" : \"b77a7bdb1c8d\"\n}", "mode" : "raw" } }, "code" : 201 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/tokens", "host" : [ "{{BASE_URL}}" ], "path" : [ "tokens" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new API token for this user" }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"user_guid\" : \"8df5d7a6-37ca-4ed4-80b4-e93eed273037\",\n \"description\" : \"b77a7bdb1c8d\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"f33c60bcbcaf\",\n \"message\" : \"6a733b482985\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/tokens/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "tokens", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "header" : [ ] }, "name" : "DELETE /tokens/:guid", "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/tokens/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "tokens", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "header" : [ ] }, "code" : 204 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "users", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/users", "host" : [ "{{BASE_URL}}" ], "path" : [ "users" ], "query" : [ { "key" : "guid", "disabled" : true, "description" : { "content" : "Find user with this guid. Exact match" } }, { "key" : "email", "disabled" : true, "description" : { "content" : "Find user with this email address. Case in-sensitive. Exact match" } }, { "key" : "token", "disabled" : true, "description" : { "content" : "Find the user with this API token. Exact match" } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Search for a specific user. You must specify at least 1 parameter - either a guid, email or token - and will receive back either 0 or 1 users." }, "header" : [ ] }, "name" : "GET /users", "description" : { "content" : "Search for a specific user. You must specify at least 1 parameter - either a guid, email or token - and will receive back either 0 or 1 users." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - [user]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/users", "host" : [ "{{BASE_URL}}" ], "path" : [ "users" ], "query" : [ { "key" : "guid", "disabled" : true, "description" : { "content" : "Find user with this guid. Exact match" } }, { "key" : "email", "disabled" : true, "description" : { "content" : "Find user with this email address. Case in-sensitive. Exact match" } }, { "key" : "token", "disabled" : true, "description" : { "content" : "Find the user with this API token. Exact match" } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Search for a specific user. You must specify at least 1 parameter - either a guid, email or token - and will receive back either 0 or 1 users." }, "header" : [ ] }, "code" : 200 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/users/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "users", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns information about the user with this guid." }, "header" : [ ] }, "name" : "GET /users/:guid", "description" : { "content" : "Returns information about the user with this guid." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - user", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/users/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "users", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns information about the user with this guid." }, "header" : [ ] }, "code" : 200 }, { "name" : "Example 404 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/users/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "users", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns information about the user with this guid." }, "header" : [ ] }, "code" : 404 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/users/authenticate", "host" : [ "{{BASE_URL}}" ], "path" : [ "users", "authenticate" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Used to authenticate a user with an email address and password. Successful authentication returns an instance of the user model. Failed authorizations of any kind are returned as a generic error with code user_authorization_failed." }, "header" : [ ] }, "name" : "POST /users/authenticate", "description" : { "content" : "Used to authenticate a user with an email address and password. Successful authentication returns an instance of the user model. Failed authorizations of any kind are returned as a generic error with code user_authorization_failed." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - user", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/users/authenticate", "host" : [ "{{BASE_URL}}" ], "path" : [ "users", "authenticate" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Used to authenticate a user with an email address and password. Successful authentication returns an instance of the user model. Failed authorizations of any kind are returned as a generic error with code user_authorization_failed." }, "header" : [ ] }, "code" : 200 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/users/authenticate", "host" : [ "{{BASE_URL}}" ], "path" : [ "users", "authenticate" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Used to authenticate a user with an email address and password. Successful authentication returns an instance of the user model. Failed authorizations of any kind are returned as a generic error with code user_authorization_failed." }, "header" : [ ] }, "body" : "[ {\n \"code\" : \"dfd2e62dfb39\",\n \"message\" : \"3eb9540c081f\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/users", "host" : [ "{{BASE_URL}}" ], "path" : [ "users" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new user." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"email\" : \"08544619d2ff\",\n \"password\" : \"ec2b74f68ef1\",\n \"nickname\" : \"3147199380c4\",\n \"name\" : \"40968898c174\"\n}", "mode" : "raw" } }, "name" : "POST /users", "description" : { "content" : "Create a new user." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - user", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/users", "host" : [ "{{BASE_URL}}" ], "path" : [ "users" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new user." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"email\" : \"08544619d2ff\",\n \"password\" : \"ec2b74f68ef1\",\n \"nickname\" : \"3147199380c4\",\n \"name\" : \"40968898c174\"\n}", "mode" : "raw" } }, "code" : 200 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/users", "host" : [ "{{BASE_URL}}" ], "path" : [ "users" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new user." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"email\" : \"08544619d2ff\",\n \"password\" : \"ec2b74f68ef1\",\n \"nickname\" : \"3147199380c4\",\n \"name\" : \"40968898c174\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"5dadfe14c8e0\",\n \"message\" : \"91aa1f6d68fa\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/users/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "users", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "PUT", "description" : { "content" : "Updates information about the user with the specified guid." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"email\" : \"b398af91cb9d\",\n \"nickname\" : \"ded58c9e6d64\",\n \"name\" : \"52fac24a79b0\"\n}", "mode" : "raw" } }, "name" : "PUT /users/:guid", "description" : { "content" : "Updates information about the user with the specified guid." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"PUT requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - user", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/users/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "users", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "PUT", "description" : { "content" : "Updates information about the user with the specified guid." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"email\" : \"b398af91cb9d\",\n \"nickname\" : \"ded58c9e6d64\",\n \"name\" : \"52fac24a79b0\"\n}", "mode" : "raw" } }, "code" : 200 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/users/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "users", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "PUT", "description" : { "content" : "Updates information about the user with the specified guid." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"email\" : \"b398af91cb9d\",\n \"nickname\" : \"ded58c9e6d64\",\n \"name\" : \"52fac24a79b0\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"da5662034712\",\n \"message\" : \"cda532d18fa4\"\n} ]", "code" : 409 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "validations", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/validations", "host" : [ "{{BASE_URL}}" ], "path" : [ "validations" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "\"3098473122d5\"", "mode" : "raw" } }, "name" : "POST /validations", "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - validation", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/validations", "host" : [ "{{BASE_URL}}" ], "path" : [ "validations" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "\"3098473122d5\"", "mode" : "raw" } }, "body" : "{\n \"valid\" : true,\n \"errors\" : [ ]\n}", "code" : 200 } ], "type" : "item" } ], "description" : { "content" : "Public resource that can accept JSON input and returns a validation object describing any validation errors." }, "type" : "folder" }, { "name" : "versions", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey" ], "query" : [ { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "The organization key for which to search versions" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "The application key for which to search versions" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Search all versions of this application. Results are always paginated." }, "header" : [ ] }, "name" : "GET /:orgKey/:applicationKey", "description" : { "content" : "Search all versions of this application. Results are always paginated." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - [version]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey" ], "query" : [ { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "The organization key for which to search versions" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "The application key for which to search versions" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Search all versions of this application. Results are always paginated." }, "header" : [ ] }, "code" : 200 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "version", "value" : "latest", "description" : { "content" : "The version of tthis application to download, or the keyword latest to get the latest version" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Retrieve a specific version of an application." }, "header" : [ ] }, "name" : "GET /:orgKey/:applicationKey/:version", "description" : { "content" : "Retrieve a specific version of an application." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - version", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "version", "value" : "latest", "description" : { "content" : "The version of tthis application to download, or the keyword latest to get the latest version" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Retrieve a specific version of an application." }, "header" : [ ] }, "code" : 200 }, { "name" : "Example 404 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "version", "value" : "latest", "description" : { "content" : "The version of tthis application to download, or the keyword latest to get the latest version" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Retrieve a specific version of an application." }, "header" : [ ] }, "code" : 404 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:version", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":version" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "version", "value" : "{{version}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Create a new version for an application" }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"original_form\" : {\n \"type\" : \"swagger_json\",\n \"data\" : \"fcaab9896512\"\n },\n \"visibility\" : \"public\"\n}", "mode" : "raw" } }, "name" : "POST /:orgKey/:version", "description" : { "content" : "Create a new version for an application" }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - version", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:version", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":version" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "version", "value" : "{{version}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Create a new version for an application" }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"original_form\" : {\n \"type\" : \"swagger_json\",\n \"data\" : \"fcaab9896512\"\n },\n \"visibility\" : \"public\"\n}", "mode" : "raw" } }, "code" : 200 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:version", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":version" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "version", "value" : "{{version}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Create a new version for an application" }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"original_form\" : {\n \"type\" : \"swagger_json\",\n \"data\" : \"fcaab9896512\"\n },\n \"visibility\" : \"public\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"56cb376eed93\",\n \"message\" : \"887ee32dcc2e\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "version", "value" : "{{version}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "PUT", "description" : { "content" : "Upsert a version of an application" }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"original_form\" : {\n \"type\" : \"api_json\",\n \"data\" : \"68e5b5b3a4cf\"\n },\n \"visibility\" : \"user\"\n}", "mode" : "raw" } }, "name" : "PUT /:orgKey/:applicationKey/:version", "description" : { "content" : "Upsert a version of an application" }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"PUT requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - version", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "version", "value" : "{{version}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "PUT", "description" : { "content" : "Upsert a version of an application" }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"original_form\" : {\n \"type\" : \"api_json\",\n \"data\" : \"68e5b5b3a4cf\"\n },\n \"visibility\" : \"user\"\n}", "mode" : "raw" } }, "code" : 200 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "version", "value" : "{{version}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "PUT", "description" : { "content" : "Upsert a version of an application" }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"original_form\" : {\n \"type\" : \"api_json\",\n \"data\" : \"68e5b5b3a4cf\"\n },\n \"visibility\" : \"user\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"103f93e00730\",\n \"message\" : \"d5f38eb65897\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "version", "value" : "{{version}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes a specific version." }, "header" : [ ] }, "name" : "DELETE /:orgKey/:applicationKey/:version", "description" : { "content" : "Deletes a specific version." }, "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "version", "value" : "{{version}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes a specific version." }, "header" : [ ] }, "code" : 204 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "watches", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/watches", "host" : [ "{{BASE_URL}}" ], "path" : [ "watches" ], "query" : [ { "key" : "guid", "disabled" : true, "description" : { "content" : "Find the watch with this guid." } }, { "key" : "user_guid", "disabled" : true, "description" : { "content" : "Find attributes for this user." } }, { "key" : "organization_key", "disabled" : true, "description" : { "content" : "Find attributes for this organization." } }, { "key" : "application_key", "disabled" : true, "description" : { "content" : "Find attributes for this application." } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Search attributes. Always paginated." }, "header" : [ ] }, "name" : "GET /watches", "description" : { "content" : "Search attributes. Always paginated." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - [watch]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/watches", "host" : [ "{{BASE_URL}}" ], "path" : [ "watches" ], "query" : [ { "key" : "guid", "disabled" : true, "description" : { "content" : "Find the watch with this guid." } }, { "key" : "user_guid", "disabled" : true, "description" : { "content" : "Find attributes for this user." } }, { "key" : "organization_key", "disabled" : true, "description" : { "content" : "Find attributes for this organization." } }, { "key" : "application_key", "disabled" : true, "description" : { "content" : "Find attributes for this application." } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Search attributes. Always paginated." }, "header" : [ ] }, "code" : 200 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/watches/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "watches", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns information about a specific watch." }, "header" : [ ] }, "name" : "GET /watches/:guid", "description" : { "content" : "Returns information about a specific watch." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - watch", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/watches/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "watches", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns information about a specific watch." }, "header" : [ ] }, "code" : 200 }, { "name" : "Example 404 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/watches/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "watches", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns information about a specific watch." }, "header" : [ ] }, "code" : 404 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/watches/check", "host" : [ "{{BASE_URL}}" ], "path" : [ "watches", "check" ], "query" : [ { "key" : "user_guid", "disabled" : true, "description" : { "content" : "The user for which we are checking. API returns false if the user guid is not provided" } }, { "key" : "organization_key", "disabled" : false, "description" : { "content" : "Type: string | Required: true" } }, { "key" : "application_key", "disabled" : false, "description" : { "content" : "Type: string | Required: true" } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Quick check if a user is watching a specific application." }, "header" : [ ] }, "name" : "GET /watches/check", "description" : { "content" : "Quick check if a user is watching a specific application." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - boolean", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/watches/check", "host" : [ "{{BASE_URL}}" ], "path" : [ "watches", "check" ], "query" : [ { "key" : "user_guid", "disabled" : true, "description" : { "content" : "The user for which we are checking. API returns false if the user guid is not provided" } }, { "key" : "organization_key", "disabled" : false, "description" : { "content" : "Type: string | Required: true" } }, { "key" : "application_key", "disabled" : false, "description" : { "content" : "Type: string | Required: true" } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Quick check if a user is watching a specific application." }, "header" : [ ] }, "body" : "true", "code" : 200 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/watches", "host" : [ "{{BASE_URL}}" ], "path" : [ "watches" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new watch." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"user_guid\" : \"c586567d-7c3c-4cf1-9d2d-b18a525bdcfe\",\n \"organization_key\" : \"8c98fed70383\",\n \"application_key\" : \"78347cbcdd78\"\n}", "mode" : "raw" } }, "name" : "POST /watches", "description" : { "content" : "Create a new watch." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 201 - watch", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/watches", "host" : [ "{{BASE_URL}}" ], "path" : [ "watches" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new watch." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"user_guid\" : \"c586567d-7c3c-4cf1-9d2d-b18a525bdcfe\",\n \"organization_key\" : \"8c98fed70383\",\n \"application_key\" : \"78347cbcdd78\"\n}", "mode" : "raw" } }, "code" : 201 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/watches", "host" : [ "{{BASE_URL}}" ], "path" : [ "watches" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new watch." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"user_guid\" : \"c586567d-7c3c-4cf1-9d2d-b18a525bdcfe\",\n \"organization_key\" : \"8c98fed70383\",\n \"application_key\" : \"78347cbcdd78\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"afc56ffbbd2e\",\n \"message\" : \"803eafe19dc1\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/watches/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "watches", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "header" : [ ] }, "name" : "DELETE /watches/:guid", "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/watches/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "watches", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "header" : [ ] }, "code" : 204 } ], "type" : "item" } ], "type" : "folder" } ], "event" : [ ], "variable" : [ { "key" : "BASE_URL", "value" : "http://api.apidoc.me", "type" : "string" } ] }