Giter VIP home page Giter VIP logo

jacamo-rest's Introduction

JaCaMo REST provides a REST API to interact with agents, artifacts and organisations.

Using this project

Include jacamo-rest dependency in build.gradle:

repositories {
    mavenCentral()

    maven { url "https://raw.github.com/jacamo-lang/mvn-repo/master" }
    maven { url "http://jacamo.sourceforge.net/maven2" }

}

dependencies {
    compile 'org.jacamo:jacamo-rest:0.5'
}

and start the API server in your .jcm application file:

mas yourmas {

    ...

    // starts rest api on port 8080 (and zookeeper on 2181)
    platform: jacamo.rest.JCMRest("--main 2181 --restPort 8080")

}

About jacamo-rest...

REST API version 0.5

  • Full documentation: jacamo-rest 0.5
  • All endpoints accepts OPTIONS returning allowed verbs

Overview

  • GET /overview: Returns MAS overview and all links

Agents

  • GET; POST /agents: Retrieves agents collection - works as white pages - (with links); append an agent.
  • GET; DELETE ../{agentuid}: Returns agent data (mind, bb and intentions (obs 1); remove.
  • GET; POST ../{agentuid}/plans Retrieves plans of the specified agent; append a plan.
  • GET ../{agentuid}/log Returns log of the specified agent.
  • POST ../{agentuid}/command Posts a new command.
  • POST ../{agentname}/inbox Posts a new message.
  • GET; POST ../{agentuid}/services Returns services provided by the specified agent; add a service to the agent.

(obs 1) /code is only provided in jacamo-web

Workspaces

  • GET; POST /workspaces: Retrieves workspaces collection (with links); append a workspace.
  • GET; POST ../{workspaceuid}/artifacts Retrieves artifacts collection; append an artifact.
  • GET ../{workspaceuid}/artifacts/{artifactuid} Returns artifact data.
  • GET /workspaces/{workspaceuid}/artifacts/{artifactuid}/properties/{obspropsuid} Returns obs props data.
  • POST /workspaces/{workspaceuid}/artifacts/{artifactuid}/operations/{operationid}/execute Execute operation.

Organisations

  • GET /organisations: Retrieves organisations collection.
  • GET ../{organisationuid} Returns organisation data (with links to artifacts).
  • POST ../{organisationuid}/roles append a role.

Services

  • GET /services: Retrieves services collection and agents that provide them - works as yellow pages

jacamo-rest's People

Contributors

cleberjamaral avatar jomifred avatar samubura avatar timkam avatar danaivach avatar vaz-rodrigo avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.