Chilkat Online Tools

SQL Server / Marketplacer SELLER API / Get a Single Custom Field by Id

Back to Collection Items

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    -- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

    EXEC sp_OASetProperty @http, 'BasicAuth', 1
    EXEC sp_OASetProperty @http, 'Login', '{{username}}'
    EXEC sp_OASetProperty @http, 'Password', '{{password}}'

    -- Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    -- The following JSON is sent in the request body.

    -- {
    --   "query": "query GetASingleCustomField($customFieldId: ID!) {\n\tnode(id: $customFieldId) {\n\t\t... on CustomField {\n\t\t\tid\n\t\t\tname\n\t\t\tdescription\n\t\t}\n\t}\n}",
    --   "variables": "{\n\t\"customFieldId\": \"Q3VzdG9tRmllbGQtMg==\"\n}"
    -- }

    DECLARE @json int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT

    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'query', 'query GetASingleCustomField($customFieldId: ID!) {' + CHAR(10) + '	node(id: $customFieldId) {' + CHAR(10) + '		... on CustomField {' + CHAR(10) + '			id' + CHAR(10) + '			name' + CHAR(10) + '			description' + CHAR(10) + '		}' + CHAR(10) + '	}' + CHAR(10) + '}'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'variables', '{' + CHAR(10) + '	"customFieldId": "Q3VzdG9tRmllbGQtMg=="' + CHAR(10) + '}'

    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'MARKETPLACER-API-KEY', '{{api_key}}'

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://bestfriendbazaar.com/graphql', 'application/json', @json
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @json
        RETURN
      END

    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    PRINT @iTmp0
    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    PRINT @sTmp0
    EXEC @hr = sp_OADestroy @resp


    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @json


END
GO

Curl Command

curl -X POST
	-u '{{username}}:{{password}}'
	-H "MARKETPLACER-API-KEY: {{api_key}}"
	-H "Content-Type: application/json"
	--data-raw '{"query":"query GetASingleCustomField($customFieldId: ID!) {\n\tnode(id: $customFieldId) {\n\t\t... on CustomField {\n\t\t\tid\n\t\t\tname\n\t\t\tdescription\n\t\t}\n\t}\n}","variables":"{\n\t\"customFieldId\": \"Q3VzdG9tRmllbGQtMg==\"\n}"}'
https://bestfriendbazaar.com/graphql

Postman Collection Item JSON

{
  "name": "Get a Single Custom Field by Id",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "MARKETPLACER-API-KEY",
        "value": "{{api_key}}",
        "type": "text"
      },
      {
        "key": "Content-Type",
        "value": "application/json",
        "type": "text"
      }
    ],
    "body": {
      "mode": "graphql",
      "graphql": {
        "query": "query GetASingleCustomField($customFieldId: ID!) {\n\tnode(id: $customFieldId) {\n\t\t... on CustomField {\n\t\t\tid\n\t\t\tname\n\t\t\tdescription\n\t\t}\n\t}\n}",
        "variables": "{\n\t\"customFieldId\": \"Q3VzdG9tRmllbGQtMg==\"\n}"
      }
    },
    "url": {
      "raw": "{{base_url}}",
      "host": [
        "{{base_url}}"
      ],
      "path": null
    },
    "description": null
  },
  "response": [
  ]
}