Delete Profile Resource

A delete_profile resource can optionally be associated with streams. The GroveStream's system will periodically delete stream intervals for streams matching the delete_profile associated with them. A delete_profile is defined by choosing a range type and the number of range types.

Delete Range Types:

MINUTE
HOUR
DAY
WEEK
MONTH
YEAR

Example
If you would like to only store one month of stream interval data then create a delete profile that has a deleteRangeType="MONTH" and numRangeTypes=1 and associate it with the streams you wish to apply it to.

Note that when intervals are deleted by the automatic GroveStreams Delete Profile logic it is similar to calling DELETE feed: all roll-up values derived from the intervals being deleted will be recalculated.

GET delete_profile

Returns a list of delete_profile resources.	Resource Information
	Rate Limited?	Yes
	session, oauth and org tokens compatible?	Yes
	api_key token token compatible?	Yes

Resource URL

http://grovestreams.com/api/delete_profile

Parameters

none

Example Requests

/delete_profile <

Response Body


					
{
   "message": "",
   "totalCount":
					2,
   "delete_profile": [
     {

					      "deleteRangeType": "MONTH",

					      "uid":
					"090cde83-a59e-4656-aa3f-61a8d9f56d2f",

					      "numRangeTypes": 2,

					      "description": "This delete profile
					will delete any intervals older than two months.",

					      "name": "Retain two months"

					    },
     {

					      "deleteRangeType": "YEAR",

					      "uid":
					"68c527dd-ba99-405e-ab49-8c39e513773d",

					      "numRangeTypes": 1,

					      "description": "Retains one year of
					stream intervals",
       "name":
					"Retain one year"
     }
   ],

					  "success": true
 }

GET delete_profile/{delete_profileUid}

Returns a delete_profile with the specified uid.	Resource Information
	Rate Limited?	Yes
	session, oauth and org tokens compatible?	Yes
	api_key token compatible?	Yes

Resource URL

http://grovestreams.com/api/delete_profile/{delete_profileUid}

Parameters

none

Example Requests

/delete_profile/090cde83-a59e-4656-aa3f-61a8d9f56d2f

Response Body


					

					{

						  "message": "",
   "delete_profile": {

						    "deleteRangeType": "MONTH",

						    "uid": "090cde83-a59e-4656-aa3f-61a8d9f56d2f",

						    "numRangeTypes": 2,
    
						"description": "This delete profile will delete any intervals
						older than two months.",
     "name": "Retain
						two months"
   },
   "success": true

						}

GET delete_profile/new

Returns a default delete_profile with a unique UID. Does not persist the new delete_profile in the store. It's the callers responsibility to PUT the new delete_profile and register it.	Resource Information
	Rate Limited?	Yes
	session, oauth and org tokens compatible?	Yes
	api_key token compatible	Yes

Resource URL

http://grovestreams.com/api/delete_profile/new

Parameters

none

Example Requests

/delete_profile/new

Response Body


					{

						  "message": "",
   "delete_profile": {

						    "deleteRangeType": "MONTH",

						    "uid": "090cde83-a59e-4656-aa3f-61a8d9f56d2f",

						    "numRangeTypes": 2,
    
						"description": "This delete profile will delete any intervals
						older than two months.",
     "name": "Retain
						two months"
   },
   "success": true

						}

PUT delete_profile

Inserts a new delete_profile. The uid of the delete_profile can be blank. If it is blank a uid will be created on the server and the response body will contain the new uid.	Resource Information
	Rate Limited?	Yes
	session, oauth and org tokens compatible?	Yes
	api_key token compatible	Yes
	org token required?	Yes

Resource URL

http://grovestreams.com/api/delete_profile

Parameters

parentFolderUid

optional

The UID of the tools content repository folder to place this new delete_profile into. The new delete_profile will be placed into the root folder if this parameter is missing.

Example Requests

/delete_profile

Request Body


					
{
   "message": "",
  
					"delete_profile": {
     "uid":
					"090cde83-a59e-4656-aa3f-61a8d9f56d2f",
    
					"deleteRangeType": "MONTH",
    
					"numRangeTypes": "2",
     "description":
					"This delete profile will delete any intervals older than two
					months.",
     "name": "Retain two months"

					  },
   "success": true
 }

POST delete_profile

Used to update an existing delete_profile.	Resource Information
	Rate Limited?	Yes
	session, oauth and org tokens compatible?	Yes
	api_key token compatible	Yes

Resource URL

http://grovestreams.com/api/delete_profile

Parameters

none

Example Requests

/delete_profile

Request Body


					
{
   "message": "",
  
					"delete_profile": {
     "uid":
					"090cde83-a59e-4656-aa3f-61a8d9f56d2f",
    
					"deleteRangeType": "MONTH",
    
					"numRangeTypes": "2",
     "description":
					"This delete profile will delete any intervals older than two
					months.",
     "name": "Retain two months"

					  },
   "success": true
 }

DELETE delete_profile/{delete_profileUid}

Deletes a delete_profile. Any streams that are referencing this delete_profile will no longer reference a delete_profile.	Resource Information
	Rate Limited?	Yes
	session, oauth and org tokens compatible?	Yes
	api_key token compatible	Yes

Resource URL

http://grovestreams.com/api/delete_profile/{delete_profileUid}

Parameters

none

Example Requests

/delete_profile/d251a8f2-f7b9-4df7-886d-b24c7f4929d4

Response Body


					   




						"message" : "Deleted delete_profile with uid
						'd251a8f2-f7b9-4df7-886d-b24c7f4929d4
					
						'",
					
					

					
						   




							"success" : true
					
					

					
						}