bulk data api

I think maybe we're misunderstanding each other a little. When you say embed the cURL call, cURL is how you would make an API call from the command line. You wouldn't use cURL inside a Khoros component. You would use restBuilder or rest or restadmin to make the same API call with freemarker. Or if you were using JavaScript, you would use fetch maybe or XMLHttpRequest. So, I think when you say "cURL call" you are referring to the same thing I mean when I say "API call".

The examples I shared are making those calls embedded in a component.

I will take the cURL example from here Create message (khoros.com) and rewrite it using restBuilder so you can see what I mean.

So here is an example with cURL from the link above.

curl -L -X POST 'https://[COMMUNITY-DOMAIN]/api/2.0/messages/' \
-H 'Content-Type: application/json' \
-H 'Li-Api-Session-Key: [SESSION-KEY]' \
--data-raw '{
    "data": {
        "type": "message",
        "board": {
            "id": "runningShoes"
        },
        "subject": "Alternative to Saucony Ride 10 GTX",
        "body": "I have the Saucony Ride 9 and got the Saucony Ride 10 GTX, but it feels very stiff while running - not much comfort/cushion while running and uncomfortable. I originally switched to Saucony because it was very comfortable and lightweight. suggestions for Saucony running shoes for women? I run only about 10mi/wk. <li-image id=\"336i254DB2339\"/>",
        "tags": {
            "items": [
                {
                    "text": "trail running"
                },
                {
                    "text": "running shoes"
                }
            ]
        },
        "labels": {
            "items": [
                {
                    "id": "womensRunningShoes",
                    "text": "Womens Running Shoes"
                },
                {
                    "id": "recommendations",
                    "text": "Recommendations"
                }
            ]
        },
        "products": {
            "items": [
                {
                    "id": "sauconyRide10gtx"
                },
                {
                    "id": "sauconyFreedomIso"
                }
            ],
            "list_item_type": "product"
        }
    }
}'

Here is my (untested) attempt to rewrite with restBuilder which you could include in a component.

<#assign messagePostCall = restBuilder()
   .method("POST")
   .path("/messages")
   .version("v2")
   .header("Content-Type","application/json")
   .header("Li-Api-Session-Key","[SESSION-KEY]")
   .body({
        "type": "message",
        "board": {
            "id": "runningShoes"
        },
        "subject": "Alternative to Saucony Ride 10 GTX",
        "body": "I have the Saucony Ride 9 and got the Saucony Ride 10 GTX, but it feels very stiff while running - not much comfort/cushion while running and uncomfortable. I originally switched to Saucony because it was very comfortable and lightweight. suggestions for Saucony running shoes for women? I run only about 10mi/wk. <li-image id=\"336i254DB2339\"/>",
        "tags": {
            "items": [
                {
                    "text": "trail running"
                },
                {
                    "text": "running shoes"
                }
            ]
        },
        "labels": {
            "items": [
                {
                    "id": "womensRunningShoes",
                    "text": "Womens Running Shoes"
                },
                {
                    "id": "recommendations",
                    "text": "Recommendations"
                }
            ]
        },
        "products": {
            "items": [
                {
                    "id": "sauconyRide10gtx"
                },
                {
                    "id": "sauconyFreedomIso"
                }
            ],
            "list_item_type": "product"
        }
    }) />

<#assign resp = messagePostCall.call() />

So, to compare the two:

• First line from cURL lists "POST" as the method which goes in "method" on restbuilder.
• Also from the first line of the cURL example is the URL 'https://[COMMUNITY-DOMAIN]/api/2.0/messages/'. Because you are inside a Khoros component you don't need to include the community domain. You also don't need to include api/2.0 as that is covered by the ".version" in restBuilder. So, all you need from the URL is the /messages which goes in the "path" on restBuilder.
• Next the content type and session key would go under .header in restBuilder.
• Lastly the "data" from cURL would be the .body in restBuilder.

Some additional notes. You don't actually need the .version("v2") here because v2 is the default. You really only need it if you are using API v1.

Also, because you are in a component, you don't really need a session key. If you are logged in Khoros knows who you are. I included it just so you could see everything from the cURL example.

Finally, if you want to make this call with admin permissions, you would add ".admin(true)" to the restBuilder.

Complete Example:

As mentioned in a previous post I was working on a component to create an abuse report. This is very similar to posting a regular message and I can share it here. This has two parts. First, a custom endpoint created in studio which is where I use restBuilder to make the API call to create the abuse report. Second, a custom compnent which I added to the "Content Archived Page". This component calls the custom endpoint I made when a button is clicked and passes along the message id.

Endpoint Code

<#assign messageId = http.request.parameters.name.get("id", "") />
<#assign path = "messages/" + messageId + "/abuse_reports" />

<#if config.getString("phase", "prod") == "stage">
    <#assign body = "***UNARCHIVE REQUEST***  https://community.stage.ptc.com/t5/contentarchivals/viewpage/message-uid/" + messageId />
<#else>
    <#assign body = "***UNARCHIVE REQUEST***  https://community.ptc.com/t5/contentarchivals/viewpage/message-uid/" + messageId />
</#if>

<#assign unarchiveCall = restBuilder()
   .method("POST")
   .path("${path}")
   .body({
        "data":{
            "type":"abuse_report",
            "body":"${body}"
        }
    })
   .admin(true) />
<#assign resp = unarchiveCall.call() />

{
    "http_code":"${resp.http_code}",
    "status" : "${resp.status}"
}

Component Code

<div id="unarchive-button-container-ak">
    <span class="lia-button lia-button-primary" id="unarchive-button-ak">Request Unarchive</span>
</div>

<div id="result-message-ak"></div>

<style>
    div#result-message-ak {
        margin-top: 20px;
    }

    #result-message-ak p {
        padding: 10px;
        font-size: 16px;
        text-align: center;
    }

    div#unarchive-button-container-ak {
        width: 194px;
        margin-left: auto;
        margin-right: auto;
    }
</style>

<@liaAddScript>
    ;(function($) {

        const unarchiveButton = document.getElementById('unarchive-button-ak');

        unarchiveButton.addEventListener("click", () => {
            const loc = window.location.pathname;
            const locArray = loc.split("/");
            const messageID = locArray[locArray.length - 1];
            console.log(messageID);
            const resultMessage = document.getElementById('result-message-ak');

            const url = '/sejnu66972/plugins/custom/ptc/ptc1/unarchive?id=' + messageID

            async function unarchiveRequest(url) {
                const response = await fetch(url, {
                    method: "POST",
                    headers: {
                        "Content-Type": "application/json"
                    }
                })

                const result = await response.json();

                console.log(result);

                if (result.status == "success") {
                    resultMessage.innerHTML = "<p>Your request was successfully sent. You should hear from a moderator within 24 business hours.</p>"
                } else {
                    resultMessage.innerHTML = "<p>There was a problem sending your request. Please try again later or contact the community team directly at [email protected]</p>"
                }
            }

            unarchiveRequest(url);
        })

    })(LITHIUM.jQuery);
</@liaAddScript>

Sorry for the wall of text. Again, hopefully that's not too much info. Also, sorry there are no comments in my code let me know if you have any questions.

I wasn't the one who set up our integration into Tableau, but I can at least point you to the documentation.

• Bulk API v3, for communities on Aurora: https://developer.khoros.com/khorosauroradevdocs/docs/bulk-data-api-v-30
• Bulk API v2, for communities on Classic
  • Overview documentation (there are a few documents, which you can access via the nav on the left on this page): https://community.khoros.com/kb/khoros-communities-classic-docs/using-the-khoros-bulk-data-api/178715?guideId=guide%3A52
  • Dev docs: https://developer.khoros.com/khoroscommunitydevdocs/reference/bulk-data-api-v2