Folder Metadata Instances - Fetch

Retrieve folder metadata instances in a Box.com account using SQL Server

Prerequisites:

See SQLHTTP easy setup for Box.xom
See API Call documentation for parameter values and other information
Create the stored procedure documented below

Stored Procedure:


CREATE PROCEDURE usp_Box_v2_Folder_AllMetadata_Fetch(
		@Profile nvarchar(100),
		@FolderID bigint,	
		@Response nvarchar(MAX) OUTPUT,
		@StatusCode int OUTPUT,
		@StatusDescription nvarchar(MAX) OUTPUT)
AS

DECLARE @URL nvarchar(MAX)
DECLARE @HTTPSessionID uniqueidentifier

SET @URL = 'https://api.box.com/2.0'

EXEC SQLHTTP.net.UrlBuilder   @URL OUTPUT,
			      @Profile,
			      'folders', @FolderID, 'metadata'

EXEC SQLHTTP.net.HTTPSession @HTTPSessionID OUTPUT

EXEC usp_Box_v2_Auth_Header @Profile, @HTTPSessionID

EXEC SQLHTTP.net.HTTPRequest 	@HttpSessionID,
				@URL = @URL,
				@Method = 'GET',
				@ContentType = 'application/json',
				@StatusCode = @StatusCode OUTPUT,
				@StatusDescription = @StatusDescription OUTPUT,
				@Response = @Response OUTPUT

GO

CREATE PROCEDURE usp_Box_v2_Folder_AllMetadata_Fetch(

@Profile nvarchar(100),

@FolderID bigint,

@Response nvarchar(MAX) OUTPUT,

@StatusCode int OUTPUT,

@StatusDescription nvarchar(MAX) OUTPUT)

DECLARE @URL nvarchar(MAX)

DECLARE @HTTPSessionID uniqueidentifier

SET @URL = 'https://api.box.com/2.0'

EXEC SQLHTTP.net.UrlBuilder @URL OUTPUT,

@Profile,

'folders', @FolderID, 'metadata'

EXEC SQLHTTP.net.HTTPSession @HTTPSessionID OUTPUT

EXEC usp_Box_v2_Auth_Header @Profile, @HTTPSessionID

EXEC SQLHTTP.net.HTTPRequest @HttpSessionID,

@URL = @URL,

@Method = 'GET',

@ContentType = 'application/json',

@StatusCode = @StatusCode OUTPUT,

@StatusDescription = @StatusDescription OUTPUT,

@Response = @Response OUTPUT



Sample Usage:


DECLARE @Response nvarchar(MAX)
DECLARE @StatusCode int
DECLARE @StatusDescription nvarchar(MAX)
DECLARE @Profile nvarchar(100)

SET @Profile = 'My Box'

--Box.com Oauth2 is token is valid for only one hour
EXEC usp_Box_v2_Auth_Refresh @Profile

EXEC usp_Box_v2_Folder_AllMetadata_Fetch
		@Profile = @Profile,
		@FolderID = '26798073761',
		@Response= @Response OUTPUT,
		@StatusCode = @StatusCode OUTPUT, 
		@StatusDescription = @StatusDescription OUTPUT

IF @StatusCode >= 400
	EXEC SQLHTTP.net.RaiseHttpError @StatusCode, @StatusDescription, @Response
ELSE
	BEGIN

		DECLARE @X xml
		SET @X = SQLHTTP.net.Json_To_Xml(@Response, '0')

		--The XPath syntax below was easily generated by executing the following commands:
		--EXEC SQLHTTP.net.XQueryHelper @X
		--and then executing: 
		--EXEC SQLHTTP.net.XQueryHelper @X, 'JsonObject/entries[1]/JsonObject'

		SELECT T.C.value(N'@_x0024_id', N'nvarchar(MAX)') AS [$id]
		      ,T.C.value(N'@_x0024_parent', N'nvarchar(MAX)') AS [$parent]
		      ,T.C.value(N'@_x0024_scope', N'nvarchar(MAX)') AS [$scope]
		      ,T.C.value(N'@_x0024_type', N'nvarchar(MAX)') AS [$type]
		FROM @X.nodes(N'/JsonObject/entries[1]/JsonObject') T(C)

	END

DECLARE @Response nvarchar(MAX)

DECLARE @StatusCode int

DECLARE @StatusDescription nvarchar(MAX)

DECLARE @Profile nvarchar(100)

SET @Profile = 'My Box'

--Box.com Oauth2 is token is valid for only one hour

EXEC usp_Box_v2_Auth_Refresh @Profile

EXEC usp_Box_v2_Folder_AllMetadata_Fetch

@Profile = @Profile,

@FolderID = '26798073761',

@Response= @Response OUTPUT,

@StatusCode = @StatusCode OUTPUT,

@StatusDescription = @StatusDescription OUTPUT

IF @StatusCode >= 400

EXEC SQLHTTP.net.RaiseHttpError @StatusCode, @StatusDescription, @Response

ELSE

BEGIN

DECLARE @X xml

SET @X = SQLHTTP.net.Json_To_Xml(@Response, '0')

--The XPath syntax below was easily generated by executing the following commands:

--EXEC SQLHTTP.net.XQueryHelper @X

--and then executing:

--EXEC SQLHTTP.net.XQueryHelper @X, 'JsonObject/entries[1]/JsonObject'

SELECT T.C.value(N'@_x0024_id', N'nvarchar(MAX)') AS [$id]

,T.C.value(N'@_x0024_parent', N'nvarchar(MAX)') AS [$parent]

,T.C.value(N'@_x0024_scope', N'nvarchar(MAX)') AS [$scope]

,T.C.value(N'@_x0024_type', N'nvarchar(MAX)') AS [$type]

FROM @X.nodes(N'/JsonObject/entries[1]/JsonObject') T(C)

END

$id $parent $scope $type

------------------------------------ ------------------- --------- -------------

48eca69b-9783-46af-8100-90bea602587c folder_26798073761 global properties

e57f90ff-0044-48c2-807d-06b908765baf folder_26798073761 internal documentFlow



IMPORTANT DISCLAIMER

CODE/SQL ON THESE PAGES ARE PROVIDED AS-IS AND ARE AVAILABLE FOR ILLUSTRATIVE PURPOSES ONLY.

USERS ARE REQUIRED TO ABIDE BY THE TERMS AND CONDITIONS FOR USING REFERENCED THIRD PARTY WEBSITES AND/OR APIs FROM THEIR RESPECTIVE WEBSITES. WE DO NOT CONDONE ANY VIOLATION OF THIRD PARTY WEBSITES AND/OR APIs TERMS AND CONDITIONS USING OUR SOFTWARE.

USERS SHALL BE SOLELY RESPONSIBLE AND BE SOLELY LIABLE FOR VIOLATION OF ANY RULES SPECIFIED BY THIRD PARTIES FOR USING THEIR WEBSITES AND/OR APIs, OR INFRINGEMENT OF RIGHTS OF SUCH THIRD PARTIES.