Need help finding some good Confluence RESTful API tutorials.

Brian Alston March 31, 2015

We are running Confluence 5.6.6. The developers before me wrote a custom plug-in that allows users to upload documents, then add information (metadata, so to speak) about the documents (e.g., workgroup, milestones, project phase, due dates, etc.). Now, the "powers that be" want some RESTful API endpoints so that other services within the company can access the documents and "metadata" via REST calls, as well as through the GUI. I am having quite a bit of trouble finding good tutorials on how to develop REST APIs on Confluence. Would somebody be so kind as to point me in the direction of some good, and beginner-friendly, tutorials?

 

Thank You, and have a good day

1 answer

Comments for this post are closed

Community moderators have prevented the ability to post new answers.

Post a new question

0 votes
Nic Brough -Adaptavist-
Community Leader
Community Leader
Community Leaders are connectors, ambassadors, and mentors. On the online community, they serve as thought leaders, product experts, and moderators.
March 31, 2015
Brian Alston March 31, 2015

Thank you, but those seem geared towards the consuming client. What I need is information on how to develop the endpoints. Thanks again.

Nic Brough -Adaptavist-
Community Leader
Community Leader
Community Leaders are connectors, ambassadors, and mentors. On the online community, they serve as thought leaders, product experts, and moderators.
March 31, 2015

Oh, I'm sorry, I misunderstood - you want to add more REST functions to Confluence. https://developer.atlassian.com/docs/atlassian-platform-common-components/rest-api-development/developing-a-rest-service-plugin gives you a skeleton and how to expose a simple function - once you've got the hang of the framework that gets a poke from the outside and responds with the results, you'll then need to delve deeper into the core Confluence API, less of the REST

Brian Alston March 31, 2015

I don't "think" want to add more REST functions to Confluence, I would like to leverage the existing REST functions that Confluence offers, to access our data. From what I understand, Confluence 5.6.6 lets you GET, PUT, POST, DELETE - as opposed to just GET in earlier Confluence versions. I need to publish my data through these RESTful functions in addition to the web GUI. I'm not sure if I'm coming across clear, or crazy.

Nic Brough -Adaptavist-
Community Leader
Community Leader
Community Leaders are connectors, ambassadors, and mentors. On the online community, they serve as thought leaders, product experts, and moderators.
March 31, 2015

Then my first answer is what you need. If you want to use the existing functions in REST, you need to write code that will issue the REST calls to login, read a page and so-on. That's what the examples are for - they show you code for pulling data out of Confluence, and for writing data into it from a remote system. They are mostly GET, yes, but if you look at the full REST API docs, you'll fund PUT and POST in there too. My second response was about the cases where the existing REST stuff does not expose what you need. But, in your last comment, you use the word "publish", which suggests something else - that you want Confluence to *push* data out. Not just make it available, but actually actively push it into another system. That's possible, with code, but it is not what REST does.

Brian Alston March 31, 2015

I know I said "publish" but I'm not looking for SOAP, I used it incorrectly. I'll look at your first links again to see if that is what I need. Like I said, we have information that other services within the company want. I need to implement the code that will allow them to connect to our Confluence plug-in, and GET, PUT, POST, DELETE from our database ... they are writing the clients that will talk to our Confluence plug-in. Thanks again.

TAGS
AUG Leaders

Atlassian Community Events