http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/146a46cc/docs/rest-endpoints/api-docs.html ---------------------------------------------------------------------- diff --git a/docs/rest-endpoints/api-docs.html b/docs/rest-endpoints/api-docs.html new file mode 100644 index 0000000..e2f3695 --- /dev/null +++ b/docs/rest-endpoints/api-docs.html @@ -0,0 +1,5867 @@ +<html> +<head> + <title>Usergrid API Reference</title> + + <!-- Latest compiled and minified CSS --> + <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap.min.css";> + + <!-- Optional theme --> + <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap-theme.min.css";> + + <link rel="stylesheet" href="api-docs.css"> + +</head> +<body> + +<div class="row"> + <div class="col-md-1"></div> + <div class="col-md-10"> + + <h1>Usergrid API Reference</h1> + <p>Generated from Swagger.</p> +<h2>Methods</h2><p>API methods are organized by the tags.</p> +<p>Following the methods is a listing of all <a href='#models'>Default Entity Models.</p> +<a name='Action-method'></a> +<h2>Action Methods</h2> + +<div class="panel panel-default"> + + <div class="panel-heading GET"> + <h2 class="panel-title GET-heading">GET /management/orgs/{orgId}/activate + <a data-toggle="collapse" data-target="#collapse-hPrzHZxcfp" + href="#collapse-hPrzHZxcfp" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-hPrzHZxcfp" class="panel-body collapse"> + + <p>Activate an organization from a link provIded in an email notification.</p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>orgId</b> (string) <br> + One of the organization's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>token</b> () <br> + Activation token. (Specified in query). + </li> + <li> + <b>confirm_email</b> () <br> + Send confirmation email or not. (Specified in query). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of complete messages.</li> + <li>Schema: [<a href="#action">Action</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> + +<div class="panel panel-default"> + + <div class="panel-heading GET"> + <h2 class="panel-title GET-heading">GET /management/orgs/{orgId}/reactivate + <a data-toggle="collapse" data-target="#collapse-rUXqeXcbWw" + href="#collapse-rUXqeXcbWw" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-rUXqeXcbWw" class="panel-body collapse"> + + <p>Reactivate an expired organization.</p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>orgId</b> (string) <br> + One of the organization's identification which includes name or uuid. (Specified in path). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of complete messages.</li> + <li>Schema: [<a href="#action">Action</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> + +<div class="panel panel-default"> + + <div class="panel-heading GET"> + <h2 class="panel-title GET-heading">GET /management/users/resetpw + <a data-toggle="collapse" data-target="#collapse-5DzMWfsnzI" + href="#collapse-5DzMWfsnzI" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-5DzMWfsnzI" class="panel-body collapse"> + + <p>Initiate the reset of an admin user's password.</p> + + <h3>Parameters</h3> + + <ul> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of complete messages.</li> + <li>Schema: [<a href="#action">Action</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> + +<div class="panel panel-default"> + + <div class="panel-heading POST"> + <h2 class="panel-title POST-heading">POST /management/users/resetpw + <a data-toggle="collapse" data-target="#collapse-N0poisDDP0" + href="#collapse-N0poisDDP0" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-N0poisDDP0" class="panel-body collapse"> + + <p>Complete the password reset through getting the newpassword and the old one for identification.</p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>ResetPWMsg</b> ( <a href="#resetpwmsg">ResetPWMsg</a>) <br> + Parameters and value for the Captcha challenge, the admin user's response to the Captcha challenge, and the admin user's email address. (Specified in body). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of complete messages.</li> + <li>Schema: [<a href="#action">Action</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> + +<div class="panel panel-default"> + + <div class="panel-heading GET"> + <h2 class="panel-title GET-heading">GET /management/users/{userId}/activate + <a data-toggle="collapse" data-target="#collapse-kBFPhSbEYr" + href="#collapse-kBFPhSbEYr" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-kBFPhSbEYr" class="panel-body collapse"> + + <p>Activate an admin user from a link provIded in an email notification.</p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>userId</b> (string) <br> + One of the user's identification which includes username, real name, email address or UUID. (Specified in path). + </li> + <li> + <b>token</b> () <br> + Activation token's query statement. (Specified in query). + </li> + <li> + <b>confirm_email</b> () <br> + Query statement of whether send confimation email or not. (Specified in query). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of complete messages.</li> + <li>Schema: [<a href="#action">Action</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> + +<div class="panel panel-default"> + + <div class="panel-heading PUT"> + <h2 class="panel-title PUT-heading">PUT /management/users/{userId}/password + <a data-toggle="collapse" data-target="#collapse-K5P6JKT5BQ" + href="#collapse-K5P6JKT5BQ" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-K5P6JKT5BQ" class="panel-body collapse"> + + <p>Update an admin user's password through getting the newpassword and the old one for identification.</p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>userId</b> (string) <br> + One of the user's identification which includes username, real name, email address or UUID. (Specified in path). + </li> + <li> + <b>ResetPW</b> ( <a href="#resetpw">ResetPW</a>) <br> + The user's old and new password. (Specified in body). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of complete messages.</li> + <li>Schema: [<a href="#action">Action</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> + +<div class="panel panel-default"> + + <div class="panel-heading GET"> + <h2 class="panel-title GET-heading">GET /management/users/{userId}/reactivate + <a data-toggle="collapse" data-target="#collapse-w5kUnyRQf1" + href="#collapse-w5kUnyRQf1" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-w5kUnyRQf1" class="panel-body collapse"> + + <p>Reactivate an expired admin user.</p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>userId</b> (string) <br> + One of the user's identification which includes username, real name, email address or UUID. (Specified in path). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of complete messages.</li> + <li>Schema: [<a href="#action">Action</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> + +<div class="panel panel-default"> + + <div class="panel-heading POST"> + <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/users/{user}/password + <a data-toggle="collapse" data-target="#collapse-bjUBCIB4Un" + href="#collapse-bjUBCIB4Un" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-bjUBCIB4Un" class="panel-body collapse"> + + <p>Set a user's password or reset the user's existing password.</p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>orgId</b> (string) <br> + One of the organization's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>appId</b> (string) <br> + One of the application's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>username</b> (string) <br> + The username of the user. (Specified in path). + </li> + <li> + <b>ResetPW</b> ( <a href="#resetpw">ResetPW</a>) <br> + The user's old and new password. (Specified in body). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of complete messages.</li> + <li>Schema: [<a href="#action">Action</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> +<a name='ActivityFeed-method'></a> +<h2>ActivityFeed Methods</h2> + +<div class="panel panel-default"> + + <div class="panel-heading GET"> + <h2 class="panel-title GET-heading">GET /management/orgs/{orgId}/feed + <a data-toggle="collapse" data-target="#collapse-vhShufjPLt" + href="#collapse-vhShufjPLt" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-vhShufjPLt" class="panel-body collapse"> + + <p>Retrieve an organization's activity feed.</p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>orgId</b> (string) <br> + One of the organization's identification which includes name or uuid. (Specified in path). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of the organization's ActivityFeed.</li> + <li>Schema: [<a href="#activityfeed">ActivityFeed</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> + +<div class="panel panel-default"> + + <div class="panel-heading GET"> + <h2 class="panel-title GET-heading">GET /management/users/{userId}/feed + <a data-toggle="collapse" data-target="#collapse-PZA4vt9hZk" + href="#collapse-PZA4vt9hZk" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-PZA4vt9hZk" class="panel-body collapse"> + + <p>Retrieve an admin user's activity feed.</p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>userId</b> (string) <br> + One of the user's identification which includes username, real name, email address or UUID. (Specified in path). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of user's activity</li> + <li>Schema: [<a href="#activityfeed">ActivityFeed</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> + +<div class="panel panel-default"> + + <div class="panel-heading POST"> + <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/groups/{groupId}/activities + <a data-toggle="collapse" data-target="#collapse-infYFpWKle" + href="#collapse-infYFpWKle" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-infYFpWKle" class="panel-body collapse"> + + <p>Create an activity to a specific group. In this case the activity is created in the activities collection and is accessible at the /activities endpoint to users who have the permission to read that endpoint. In addition, a relationship is established between the activity and the group, and because of that, the activity will appear in the groupâs feed. The group 'owns' the activity. Also, the activity will be published in the feed of all users that are members of the group.</p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>orgId</b> (string) <br> + One of the organization's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>appId</b> (string) <br> + One of the application's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>groupId</b> (string) <br> + One of the group's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>CreateActivity</b> ( <a href="#createactivity">CreateActivity</a>) <br> + One or more sets of activity properties. (Specified in body). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of user's activity.</li> + <li>Schema: [<a href="#activityfeed">ActivityFeed</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> + +<div class="panel panel-default"> + + <div class="panel-heading GET"> + <h2 class="panel-title GET-heading">GET /{orgId}/{appId}/groups/{groupId}/feed + <a data-toggle="collapse" data-target="#collapse-F48J7eadTI" + href="#collapse-F48J7eadTI" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-F48J7eadTI" class="panel-body collapse"> + + <p>Get a group's feed through providing all the identifications.</p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>orgId</b> (string) <br> + One of the organization's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>appId</b> (string) <br> + One of the application's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>groupId</b> (string) <br> + One of the group's identification which includes name or uuid. (Specified in path). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of group's activity.</li> + <li>Schema: [<a href="#activityfeed">ActivityFeed</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> + +<div class="panel panel-default"> + + <div class="panel-heading POST"> + <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/users/{userId}/activities + <a data-toggle="collapse" data-target="#collapse-a7GwTBDTzW" + href="#collapse-a7GwTBDTzW" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-a7GwTBDTzW" class="panel-body collapse"> + + <p>Create an activity in the activities collection.</p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>orgId</b> (string) <br> + One of the organization's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>appId</b> (string) <br> + One of the application's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>userId-3</b> (string) <br> + One of the user's identification which includes username or UUID. (Specified in path). + </li> + <li> + <b>CreateActivity</b> ( <a href="#createactivity">CreateActivity</a>) <br> + One or more sets of activity properties. (Specified in body). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of user's activity.</li> + <li>Schema: [<a href="#activityfeed">ActivityFeed</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> + +<div class="panel panel-default"> + + <div class="panel-heading GET"> + <h2 class="panel-title GET-heading">GET /{orgId}/{appId}/users/{userId}/feed + <a data-toggle="collapse" data-target="#collapse-gI92NEvICd" + href="#collapse-gI92NEvICd" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-gI92NEvICd" class="panel-body collapse"> + + <p>Retrieve a user's feed through providing all the identifications.</p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>orgId</b> (string) <br> + One of the organization's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>appId</b> (string) <br> + One of the application's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>userId-3</b> (string) <br> + One of the user's identification which includes username or UUID. (Specified in path). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of user's activity feed.</li> + <li>Schema: [<a href="#activityfeed">ActivityFeed</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> +<a name='AppData-method'></a> +<h2>AppData Methods</h2> + +<div class="panel panel-default"> + + <div class="panel-heading GET"> + <h2 class="panel-title GET-heading">GET /management/orgs/{orgId}/apps + <a data-toggle="collapse" data-target="#collapse-MzqKY504Sg" + href="#collapse-MzqKY504Sg" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-MzqKY504Sg" class="panel-body collapse"> + + <p>Retrieve the applications in an organization through providing both Id of application and organization.</p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>orgId</b> (string) <br> + One of the organization's identification which includes name or uuid. (Specified in path). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of retrieved application data.</li> + <li>Schema: [<a href="#appdata">AppData</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> + +<div class="panel panel-default"> + + <div class="panel-heading DELETE"> + <h2 class="panel-title DELETE-heading">DELETE /management/orgs/{orgId}/apps/{appId} + <a data-toggle="collapse" data-target="#collapse-9bDyzlQ1Iu" + href="#collapse-9bDyzlQ1Iu" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-9bDyzlQ1Iu" class="panel-body collapse"> + + <p>Remove an application from an organization through providing both Id of application and organization.</p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>orgId</b> (string) <br> + One of the organization's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>appId</b> (string) <br> + One of the application's identification which includes name or uuid. (Specified in path). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of deleted application info.</li> + <li>Schema: [<a href="#appdata">AppData</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> +<a name='Credential-method'></a> +<h2>Credential Methods</h2> + +<div class="panel panel-default"> + + <div class="panel-heading GET"> + <h2 class="panel-title GET-heading">GET /management/orgs/{orgId}/apps/{appId}/credentials + <a data-toggle="collapse" data-target="#collapse-0HIFhrr5UQ" + href="#collapse-0HIFhrr5UQ" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-0HIFhrr5UQ" class="panel-body collapse"> + + <p>Retrieve the client Id and client secret credentials for an application in an organization.</p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>orgId</b> (string) <br> + One of the organization's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>appId</b> (string) <br> + One of the application's identification which includes name or uuid. (Specified in path). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of retrieved credentials info.</li> + <li>Schema: [<a href="#credential">Credential</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> + +<div class="panel panel-default"> + + <div class="panel-heading POST"> + <h2 class="panel-title POST-heading">POST /management/orgs/{orgId}/apps/{appId}/credentials + <a data-toggle="collapse" data-target="#collapse-NcmWMgxRww" + href="#collapse-NcmWMgxRww" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-NcmWMgxRww" class="panel-body collapse"> + + <p>Generate the client Id and client secret credentials for an application in an organization.</p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>orgId</b> (string) <br> + One of the organization's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>appId</b> (string) <br> + One of the application's identification which includes name or uuid. (Specified in path). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of generated credentials info.</li> + <li>Schema: [<a href="#credential">Credential</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> + +<div class="panel panel-default"> + + <div class="panel-heading GET"> + <h2 class="panel-title GET-heading">GET /management/orgs/{orgId}/credentials + <a data-toggle="collapse" data-target="#collapse-CCsm4RPMzm" + href="#collapse-CCsm4RPMzm" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-CCsm4RPMzm" class="panel-body collapse"> + + <p>Retrieve the credentials for an organization client.</p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>orgId</b> (string) <br> + One of the organization's identification which includes name or uuid. (Specified in path). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of Credential</li> + <li>Schema: [<a href="#credential">Credential</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> + +<div class="panel panel-default"> + + <div class="panel-heading POST"> + <h2 class="panel-title POST-heading">POST /management/orgs/{orgId}/credentials + <a data-toggle="collapse" data-target="#collapse-LiT2CvsmDw" + href="#collapse-LiT2CvsmDw" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-LiT2CvsmDw" class="panel-body collapse"> + + <p>Generate whole new credentials for an organization client.</p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>orgId</b> (string) <br> + One of the organization's identification which includes name or uuid. (Specified in path). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of Credential</li> + <li>Schema: [<a href="#credential">Credential</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> +<a name='Devices-method'></a> +<h2>Devices Methods</h2> + +<div class="panel panel-default"> + + <div class="panel-heading GET"> + <h2 class="panel-title GET-heading">GET /{orgId}/{appId}/{notificationId}/*/queue + <a data-toggle="collapse" data-target="#collapse-R9DoRK71tr" + href="#collapse-R9DoRK71tr" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-R9DoRK71tr" class="panel-body collapse"> + + <p>Retrieve the list of devices associated with one or more notifications before the notifications are sent through providing all the identifications.</p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>orgId</b> (string) <br> + One of the organization's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>appId</b> (string) <br> + One of the application's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>notificationId</b> (string) <br> + One of the notification's identification which includes name or uuid. (Specified in path). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of retrieved device's info.</li> + <li>Schema: [<a href="#device">Device</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> +<a name='Entity-method'></a> +<h2>Entity Methods</h2> + +<div class="panel panel-default"> + + <div class="panel-heading GET"> + <h2 class="panel-title GET-heading">GET /{orgId}/{appId}/users/{userId}/{relation} + <a data-toggle="collapse" data-target="#collapse-qqHr1Ma9t6" + href="#collapse-qqHr1Ma9t6" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-qqHr1Ma9t6" class="panel-body collapse"> + + <p>Retrieve a user's collections or connections through query statement.</p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>orgId</b> (string) <br> + One of the organization's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>appId</b> (string) <br> + One of the application's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>userId-3</b> (string) <br> + One of the user's identification which includes username or UUID. (Specified in path). + </li> + <li> + <b>relation</b> (string) <br> + The relation between user and collections. (Specified in path). + </li> + <li> + <b>queryStatement</b> () <br> + The query statement of the user. (Specified in query). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of user's collections info.</li> + <li>Schema: [<a href="#entity">Entity</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> + +<div class="panel panel-default"> + + <div class="panel-heading GET"> + <h2 class="panel-title GET-heading">GET /{orgId}/{appId}/{collectionId} + <a data-toggle="collapse" data-target="#collapse-cDWeKX5Sgp" + href="#collapse-cDWeKX5Sgp" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-cDWeKX5Sgp" class="panel-body collapse"> + + <p>Retrieve collection through query statement.</p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>orgId</b> (string) <br> + One of the organization's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>appId</b> (string) <br> + One of the application's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>collectionId</b> (string) <br> + One of the collection's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>queryStatement</b> () <br> + Any values specified in the query statement should be enclosed in single-quotes. (Specified in query). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of retrieved collection's info.</li> + <li>Schema: [<a href="#entity">Entity</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> + +<div class="panel panel-default"> + + <div class="panel-heading PUT"> + <h2 class="panel-title PUT-heading">PUT /{orgId}/{appId}/{collectionId} + <a data-toggle="collapse" data-target="#collapse-UamN5fAOJg" + href="#collapse-UamN5fAOJg" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-UamN5fAOJg" class="panel-body collapse"> + + <p>Update collection through query statement.</p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>orgId</b> (string) <br> + One of the organization's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>appId</b> (string) <br> + One of the application's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>collectionId</b> (string) <br> + One of the collection's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>queryStatement</b> () <br> + Any values specified in the query statement should be enclosed in single-quotes. (Specified in query). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of updated collection's info.</li> + <li>Schema: [<a href="#entity">Entity</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> + +<div class="panel panel-default"> + + <div class="panel-heading POST"> + <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/{collectionId}/{entityId1}/{relation}/{entityId2} + <a data-toggle="collapse" data-target="#collapse-IG7hXlb6xe" + href="#collapse-IG7hXlb6xe" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-IG7hXlb6xe" class="panel-body collapse"> + + <p>Add an entity to a collection through providing all the identifications.</p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>orgId</b> (string) <br> + One of the organization's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>appId</b> (string) <br> + One of the application's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>collectionId</b> (string) <br> + One of the collection's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>entityId1</b> (string) <br> + The Id of the 1st entity. (Specified in path). + </li> + <li> + <b>relation</b> (string) <br> + The relation between 1st entity and 2nd entity. (Specified in path). + </li> + <li> + <b>entityId2</b> (string) <br> + The Id of the 2nd entity. (Specified in path). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of added entity's info.</li> + <li>Schema: [<a href="#entity">Entity</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> + +<div class="panel panel-default"> + + <div class="panel-heading DELETE"> + <h2 class="panel-title DELETE-heading">DELETE /{orgId}/{appId}/{collectionId}/{entityId1}/{relation}/{entityId2} + <a data-toggle="collapse" data-target="#collapse-C4JeUtnKwe" + href="#collapse-C4JeUtnKwe" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-C4JeUtnKwe" class="panel-body collapse"> + + <p>Remove an entity from a collection through providing all the identifications.</p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>orgId</b> (string) <br> + One of the organization's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>appId</b> (string) <br> + One of the application's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>collectionId</b> (string) <br> + One of the collection's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>entityId1</b> (string) <br> + The Id of the 1st entity. (Specified in path). + </li> + <li> + <b>relation</b> (string) <br> + The relation between 1st entity and 2nd entity. (Specified in path). + </li> + <li> + <b>entityId2</b> (string) <br> + The Id of the 2nd entity. (Specified in path). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of deleted entity's info.</li> + <li>Schema: [<a href="#entity">Entity</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> + +<div class="panel panel-default"> + + <div class="panel-heading GET"> + <h2 class="panel-title GET-heading">GET /{orgId}/{appId}/{collectionId}/{entityId} + <a data-toggle="collapse" data-target="#collapse-uIOSV7bCyk" + href="#collapse-uIOSV7bCyk" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-uIOSV7bCyk" class="panel-body collapse"> + + <p>Retrieve an entity through providing Id of application, organization, collection and entity.</p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>orgId</b> (string) <br> + One of the organization's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>appId</b> (string) <br> + One of the application's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>collectionId</b> (string) <br> + One of the collection's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>entityId</b> (string) <br> + One of the entity's identification which includes name or uuid. (Specified in path). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of retrieved entity's info.</li> + <li>Schema: [<a href="#entity">Entity</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> + +<div class="panel panel-default"> + + <div class="panel-heading PUT"> + <h2 class="panel-title PUT-heading">PUT /{orgId}/{appId}/{collectionId}/{entityId} + <a data-toggle="collapse" data-target="#collapse-ImzHpxaGCP" + href="#collapse-ImzHpxaGCP" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-ImzHpxaGCP" class="panel-body collapse"> + + <p>One or more properties can be updated with a single request.</p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>orgId</b> (string) <br> + One of the organization's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>appId</b> (string) <br> + One of the application's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>collectionId</b> (string) <br> + One of the collection's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>entityId</b> (string) <br> + One of the entity's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>entityproperty</b> ( <a href="#createentities">CreateEntities</a>) <br> + The properties of the entity. (Specified in body). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of updated entity's info.</li> + <li>Schema: [<a href="#entity">Entity</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> + +<div class="panel panel-default"> + + <div class="panel-heading DELETE"> + <h2 class="panel-title DELETE-heading">DELETE /{orgId}/{appId}/{collectionId}/{entityId} + <a data-toggle="collapse" data-target="#collapse-B5CFNoX5Mn" + href="#collapse-B5CFNoX5Mn" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-B5CFNoX5Mn" class="panel-body collapse"> + + <p>Delete an entity from the collection.</p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>orgId</b> (string) <br> + One of the organization's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>appId</b> (string) <br> + One of the application's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>collectionId</b> (string) <br> + One of the collection's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>entityId</b> (string) <br> + One of the entity's identification which includes name or uuid. (Specified in path). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of deleted entity's info.</li> + <li>Schema: [<a href="#entity">Entity</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> + +<div class="panel panel-default"> + + <div class="panel-heading POST"> + <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/{entitytype} + <a data-toggle="collapse" data-target="#collapse-f6cEBGONJe" + href="#collapse-f6cEBGONJe" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-f6cEBGONJe" class="panel-body collapse"> + + <p>When a new entity is created, Usergrid will automatically create a corresponding collection if one does not already exist. The collection will automatically be named with the plural form of the entity type. </p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>orgId</b> (string) <br> + One of the organization's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>appId</b> (string) <br> + One of the application's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>entitytype</b> (string) <br> + The entity type to create. (Specified in path). + </li> + <li> + <b>entityproperty</b> ( <a href="#createentities">CreateEntities</a>) <br> + The properties of the entity. (Specified in body). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of created custom entity's info.</li> + <li>Schema: [<a href="#entity">Entity</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> +<a name='Event-method'></a> +<h2>Event Methods</h2> + +<div class="panel panel-default"> + + <div class="panel-heading POST"> + <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/events + <a data-toggle="collapse" data-target="#collapse-adCzvSbGZZ" + href="#collapse-adCzvSbGZZ" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-adCzvSbGZZ" class="panel-body collapse"> + + <p>Create an event through providing both Id of organization and application.</p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>orgId</b> (string) <br> + One of the organization's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>appId</b> (string) <br> + One of the application's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>CreateEvent</b> ( <a href="#createevent">CreateEvent</a>) <br> + The required property of the event. (Specified in body). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of created event's info.</li> + <li>Schema: [<a href="#event">Event</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> +<a name='Group-method'></a> +<h2>Group Methods</h2> + +<div class="panel panel-default"> + + <div class="panel-heading POST"> + <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/groups + <a data-toggle="collapse" data-target="#collapse-lFsGInVBhh" + href="#collapse-lFsGInVBhh" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-lFsGInVBhh" class="panel-body collapse"> + + <p>Create a new group through providing both Id of organization and application.</p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>orgId</b> (string) <br> + One of the organization's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>appId</b> (string) <br> + One of the application's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>groupproperty</b> ( <a href="#creategroup">CreateGroup</a>) <br> + The property of the created group. (Specified in body). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of created group's info.</li> + <li>Schema: [<a href="#group">Group</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> + +<div class="panel panel-default"> + + <div class="panel-heading GET"> + <h2 class="panel-title GET-heading">GET /{org_Id}/{app_Id}/groups/{groupId} + <a data-toggle="collapse" data-target="#collapse-6SvWWSNvM3" + href="#collapse-6SvWWSNvM3" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-6SvWWSNvM3" class="panel-body collapse"> + + <p>Get a group through through providing all the identifications.</p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>orgId</b> (string) <br> + One of the organization's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>appId</b> (string) <br> + One of the application's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>groupId</b> (string) <br> + One of the group's identification which includes name or uuid. (Specified in path). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of retrieved group's info.</li> + <li>Schema: [<a href="#group">Group</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> + +<div class="panel panel-default"> + + <div class="panel-heading PUT"> + <h2 class="panel-title PUT-heading">PUT /{org_Id}/{app_Id}/groups/{groupId} + <a data-toggle="collapse" data-target="#collapse-JnEwKrzfKI" + href="#collapse-JnEwKrzfKI" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-JnEwKrzfKI" class="panel-body collapse"> + + <p>Update a group through providing all the identifications.</p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>orgId</b> (string) <br> + One of the organization's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>appId</b> (string) <br> + One of the application's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>groupId</b> (string) <br> + One of the group's identification which includes name or uuid. (Specified in path). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of updated group's info.</li> + <li>Schema: [<a href="#group">Group</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> +<a name='Notification-method'></a> +<h2>Notification Methods</h2> + +<div class="panel panel-default"> + + <div class="panel-heading PUT"> + <h2 class="panel-title PUT-heading">PUT /my-org/sandbox/notifications/{notificationId} + <a data-toggle="collapse" data-target="#collapse-C5Bi274WhA" + href="#collapse-C5Bi274WhA" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-C5Bi274WhA" class="panel-body collapse"> + + <p>Cancel sent notifications through providing the Id of the notification.</p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>notificationId</b> (string) <br> + One of the notification's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>cancelMsg</b> ( <a href="#cancelmsg">CancelMSG</a>) <br> + Indicete whether is canceled or not. (Specified in body). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of canceled notification's info.</li> + <li>Schema: [<a href="#notification">Notification</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> + +<div class="panel panel-default"> + + <div class="panel-heading POST"> + <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/devices + <a data-toggle="collapse" data-target="#collapse-m2n9YUBs9u" + href="#collapse-m2n9YUBs9u" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-m2n9YUBs9u" class="panel-body collapse"> + + <p>Create notifications for user through targeting by location and providing all the identifications.</p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>orgId</b> (string) <br> + One of the organization's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>appId</b> (string) <br> + One of the application's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>notification</b> ( <a href="#createnotifications">CreateNotifications</a>) <br> + These parameters are used when forming the notification portion of the request. (Specified in body). + </li> + <li> + <b>scheduleNotification</b> ( <a href="#schedulenotification">ScheduleNotification</a>) <br> + To schedule a notification for a later time add the deliver parameter with a UNIX timestamp to the body of your request. (Specified in body). + </li> + <li> + <b>setExpiration</b> ( <a href="#setexpiration">SetExpiration</a>) <br> + If a push service can't deliver a message to a device and needs to resend it you can set a notification to expire after a certain date/time. (Specified in body). + </li> + <li> + <b>queryStatement</b> () <br> + The query statement of the location of the user. (Specified in query). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of created notification's info.</li> + <li>Schema: [<a href="#notification">Notification</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> + +<div class="panel panel-default"> + + <div class="panel-heading POST"> + <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/devices/*/notifications + <a data-toggle="collapse" data-target="#collapse-j6URiveU80" + href="#collapse-j6URiveU80" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-j6URiveU80" class="panel-body collapse"> + + <p>Create notifications for all devices. This request will target all device entities.</p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>orgId</b> (string) <br> + One of the organization's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>appId</b> (string) <br> + One of the application's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>notification</b> ( <a href="#createnotifications">CreateNotifications</a>) <br> + These parameters are used when forming the notification portion of the request. (Specified in body). + </li> + <li> + <b>scheduleNotification</b> ( <a href="#schedulenotification">ScheduleNotification</a>) <br> + To schedule a notification for a later time add the deliver parameter with a UNIX timestamp to the body of your request. (Specified in body). + </li> + <li> + <b>setExpiration</b> ( <a href="#setexpiration">SetExpiration</a>) <br> + If a push service can't deliver a message to a device and needs to resend it you can set a notification to expire after a certain date/time. (Specified in body). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of created notification's info.</li> + <li>Schema: [<a href="#notification">Notification</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> + +<div class="panel panel-default"> + + <div class="panel-heading POST"> + <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/devices/{deviceId}/notifications + <a data-toggle="collapse" data-target="#collapse-0pznNvWn6n" + href="#collapse-0pznNvWn6n" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-0pznNvWn6n" class="panel-body collapse"> + + <p>Create notifications for a single device. This request will target a specific device entity.</p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>orgId</b> (string) <br> + One of the organization's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>appId</b> (string) <br> + One of the application's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>deviceId</b> (string) <br> + One of the device's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>notification</b> ( <a href="#createnotifications">CreateNotifications</a>) <br> + These parameters are used when forming the notification portion of the request. (Specified in body). + </li> + <li> + <b>scheduleNotification</b> ( <a href="#schedulenotification">ScheduleNotification</a>) <br> + To schedule a notification for a later time add the deliver parameter with a UNIX timestamp to the body of your request. (Specified in body). + </li> + <li> + <b>setExpiration</b> ( <a href="#setexpiration">SetExpiration</a>) <br> + If a push service can't deliver a message to a device and needs to resend it you can set a notification to expire after a certain date/time. (Specified in body). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of created notification's info.</li> + <li>Schema: [<a href="#notification">Notification</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> + +<div class="panel panel-default"> + + <div class="panel-heading POST"> + <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/groups/{path}/notifications + <a data-toggle="collapse" data-target="#collapse-k6OZ0uisP3" + href="#collapse-k6OZ0uisP3" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-k6OZ0uisP3" class="panel-body collapse"> + + <p>Create notifications for a group. This request will target all users associated with a specific group entity.</p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>orgId</b> (string) <br> + One of the organization's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>appId</b> (string) <br> + One of the application's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>path</b> (string) <br> + The path of the group. (Specified in path). + </li> + <li> + <b>notification</b> ( <a href="#createnotifications">CreateNotifications</a>) <br> + These parameters are used when forming the notification portion of the request. (Specified in body). + </li> + <li> + <b>scheduleNotification</b> ( <a href="#schedulenotification">ScheduleNotification</a>) <br> + To schedule a notification for a later time add the deliver parameter with a UNIX timestamp to the body of your request. (Specified in body). + </li> + <li> + <b>setExpiration</b> ( <a href="#setexpiration">SetExpiration</a>) <br> + If a push service can't deliver a message to a device and needs to resend it you can set a notification to expire after a certain date/time. (Specified in body). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of created notification's info.</li> + <li>Schema: [<a href="#notification">Notification</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> + +<div class="panel panel-default"> + + <div class="panel-heading GET"> + <h2 class="panel-title GET-heading">GET /{orgId}/{appId}/notifications + <a data-toggle="collapse" data-target="#collapse-SkWlNUac7o" + href="#collapse-SkWlNUac7o" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-SkWlNUac7o" class="panel-body collapse"> + + <p>Retrieve one or more notifications through providing all the identifications.</p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>orgId</b> (string) <br> + One of the organization's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>appId</b> (string) <br> + One of the application's identification which includes name or uuid. (Specified in path). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of retrieved notification's info.</li> + <li>Schema: [<a href="#notification">Notification</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> + +<div class="panel panel-default"> + + <div class="panel-heading DELETE"> + <h2 class="panel-title DELETE-heading">DELETE /{orgId}/{appId}/notifications/{notificationId} + <a data-toggle="collapse" data-target="#collapse-iMKGjTVFXM" + href="#collapse-iMKGjTVFXM" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-iMKGjTVFXM" class="panel-body collapse"> + + <p>Remove unsent notifications through providing all the identifications.</p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>orgId</b> (string) <br> + One of the organization's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>appId</b> (string) <br> + One of the application's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>notificationId</b> (string) <br> + One of the notification's identification which includes name or uuid. (Specified in path). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of deleted notification's info.</li> + <li>Schema: [<a href="#notification">Notification</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> + +<div class="panel panel-default"> + + <div class="panel-heading POST"> + <h2 class="panel-title POST-heading">POST /{orgId}/{appId}/users/{userId}/notifications + <a data-toggle="collapse" data-target="#collapse-aJg9LCAC38" + href="#collapse-aJg9LCAC38" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-aJg9LCAC38" class="panel-body collapse"> + + <p>Create notifications for a user. This request will target a specific user entity.</p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>orgId</b> (string) <br> + One of the organization's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>appId</b> (string) <br> + One of the application's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>userId-3</b> (string) <br> + One of the user's identification which includes username or UUID. (Specified in path). + </li> + <li> + <b>notification</b> ( <a href="#createnotifications">CreateNotifications</a>) <br> + These parameters are used when forming the notification portion of the request. (Specified in body). + </li> + <li> + <b>scheduleNotification</b> ( <a href="#schedulenotification">ScheduleNotification</a>) <br> + To schedule a notification for a later time add the deliver parameter with a UNIX timestamp to the body of your request. (Specified in body). + </li> + <li> + <b>setExpiration</b> ( <a href="#setexpiration">SetExpiration</a>) <br> + If a push service can't deliver a message to a device and needs to resend it you can set a notification to expire after a certain date/time. (Specified in body). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of created notification's info.</li> + <li>Schema: [<a href="#notification">Notification</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> + +<div class="panel panel-default"> + + <div class="panel-heading GET"> + <h2 class="panel-title GET-heading">GET /{orgId}/{appId}/{receiptId}/*/notifications + <a data-toggle="collapse" data-target="#collapse-DC2BWfAf5J" + href="#collapse-DC2BWfAf5J" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-DC2BWfAf5J" class="panel-body collapse"> + + <p>Retrieve notifications associated with one or more receipts through providing all the identifications.</p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>orgId</b> (string) <br> + One of the organization's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>appId</b> (string) <br> + One of the application's identification which includes name or uuid. (Specified in path). + </li> + <li> + <b>receiptId</b> (string) <br> + One of the receipt's identification which includes name or uuid. (Specified in path). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of retrieved notification's info.</li> + <li>Schema: [<a href="#notification">Notification</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> +<a name='Organization-method'></a> +<h2>Organization Methods</h2> + +<div class="panel panel-default"> + + <div class="panel-heading POST"> + <h2 class="panel-title POST-heading">POST /management/orgs + <a data-toggle="collapse" data-target="#collapse-NYrTIDBeIG" + href="#collapse-NYrTIDBeIG" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-NYrTIDBeIG" class="panel-body collapse"> + + <p>Create an organization through a form post.</p> + + <h3>Parameters</h3> + + <ul> + <li> + <b>CreateOrg</b> ( <a href="#createorg">CreateOrg</a>) <br> + A set of organization properties supplied through a form. (Specified in body). + </li> + </ul> + + <h3>Responses</h3> + + <ul> + <li> + <b>200</b> + <ul> + <li>Description: An array of created Organization.</li> + <li>Schema: [<a href="#organization">Organization</a>]</li> + </ul> + </li> + <li> + <b>default</b> + <ul> + <li>Description: Unexpected error.</li> + <li>Schema: [<a href="#error">Error</a>]</li> + </ul> + </li> + </ul> + + </div> + <!--<div class="panel-footer"></div>--> +</div> + +<div class="panel panel-default"> + + <div class="panel-heading GET"> + <h2 class="panel-title GET-heading">GET /management/orgs/{orgId} + <a data-toggle="collapse" data-target="#collapse-FDH6idxDVH" + href="#collapse-FDH6idxDVH" class="collapsed collapse-button"> </a> + </h2> + </div> + + <div id="collapse-FDH6idxDVH" class="panel-body collapse"> + + <p>Retrieve an organization given a specified UUID or username.</p> + +
<TRUNCATED>
