2014-06-04T11:59:34Z

Alsroot:

The following diagram shows the full list of objects implemented by the Sugar Network [[Platform Team/Sugar Network/API|API]].

{| border="0"
|- valign="top" align="let"
| [[File:Sugar-Network-diagram.png|200px|thumb|Sugar Network objects]]
|}

<div id="resource-types"></div>

'''Property types'''

Generally, Sugar Network objects' property types correspond to JSON types. The only exceptions mentioned in the following list:

* ''enum'', is an enumerated type when a value is a string from the predefined list of constants;
* ''markdown'', is a string formatted in the [[Wikipedia:Markdown|Markdown]] syntax;
* ''blob'', is a file represented by string value which is a [[Wikipedia:Sha1|SHA-1]] digest of file's content; the file itself can be obtained from the {{Code|'''GET''' /blobs/''DIGEST''}} request;
* ''aggregated'', is a list of JSON objects which has [[Sugar_Network/API#Aggregated_properties|special API]] to treat its items; each aggregated item has a unique identifier; items might be created not only by the object's authors.

<div id="resource-author"></div>

'''Resource.author'''

A dictionary of authors working on the corresponding resource. Keys are Sugar Network ''User'' guids, or, if particular author is not registered in the Sugar Network, full user names. Values are dictionaries with the following keys:

* ''name''<br>Full author's name;
* ''role''<br>An integer which is a bit-wise ORed value of the following constants:
** ''0x1'', author is registered in the Sugar Network (and ''guid'' key is set);
** ''0x10000'', author is the original author of the corresponding resource; if it is not set, user is only a maintainer, e.g., an uploader of a book which has its original authors.

<div id="resource-status"></div>

'''Resource.status'''

This is a system level property which can be set only by node editors. It is a list of "badges" editors set depending on the object quality. Currently supported statuses are:

* ''featured'', the object is popped up by node editors.

<div id="resource-pins"></div>

'''Resource.pins'''

This property makes sense only for objects provided from a [[Sugar_Network/API#Client_proxy|local proxy]]. The property is intended to store local user's preferences or statuses remote object has in local environment. Currently supported values are:

* ''favorite'', set if a user has ''"stared"'' the object;
* ''checkin'', applied to Context objects only, set if a user has ''"pinned"'' the context to keep its most recent version permanently in the local system;
* ''stale'', applied to Context objects only, set if previously checked-in Context might have more fresh releases on the node; it is not possible to filter Contexts by this value;
* ''inprogress'', applied to Context objects only, set if the Context is in the process of downloading content from the node; it is being temporally set before launching the Context or checking it in; it is not possible to filter Contexts by this value.

<div id="context-type"></div>

'''Context.type'''

* ''activity'', Sugar activity;
* ''book'', books in various forms;
* ''talks'', offline discussion groups;
* ''project'', general purpose context to group related Post objects;
* ''package'', GNU/Linux package metadata.

Context type specifies how context, and all related resources, can be used. For example, ''activity'' type assumes activity bundles uploaded to the ''Context.releases'' property, or, [[#post-type|Post.type]] depends on Context type it was created for.

<div id="context-releases"></div>

'''Context.releases'''

Contexts with ''activity'' or ''book'' types might have releases, i.e., activity or book versions that users can download. The ''releases'' property is aggregated where each item describes one particular version. There is no need in working with the ''releases'' property directly, there are high-level API commands to [[Sugar_Network/API#Upload_releases|upload]] and [[Sugar_Network/API#Retrieving_releases|download]] releases.

<div id="post-type"></div>

'''Post.type'''

Choose Post types according to Context [[#context-type|types]] the Post belongs to.

* ''topic'', general purpose discussion; ''talks'' Contexts;
* ''review'', review the Context; ''activity'' or ''book'' Contexts;
* ''artefact'', object generated by Context application; ''activity'' Contexts;
* ''question'', Q&A request; ''project'' Contexts;
* ''issue'', problem with the Context; ''project'' Contexts;
* ''poll'', a poll within the Context; ''project'' Contexts;
* ''notice'', auto-generated Post for updates within the Context; Context type independent;
* ''post'', a comment for a parent Post object; Context type independent.

<div id="post-topic"></div>

'''Post.topic'''

Only ''post'' type Post objects belong to a parent Post which guid should be specified in the ''topic'' property. The system design assumes only a two-level Posts hierarchy.

<div id="post-topic"></div>

'''Post.resolution'''

Post types ''question'', ''issue'', or, ''poll'' might have a resolution to expose the current status.

Resolutions for ''question'' Post objects:
* ''takeback'', the question is taken back by the author;
* Post guid which is a solution for the question.

Resolutions for ''issue'' Post objects:
* ''new'', newly created issue;
* ''needinfo'', posted information about the issue is insufficient, more details needed;
* ''resolved'', the issue is resolved, closed;
* ''unrelated'', the issue does not related to the Context, closed;
* ''obsolete'', the issue is already solved in recent Context releases, closed;
* ''duplicate'', the issue is a duplicate, closed.

Resolutions for ''poll'' Post objects:
* ''open'', the poll is open for votes;
* ''closed'', the poll is closed for votes.

Only the ''question'' and ''poll'' Post types allow changing resolution by the Post authors. Assigning resolution for ''issue'' type Posts is available for Context authors. Due to complex authority validations, setting resolution value can happen only via direct [[Sugar_Network/API#PUT-property|POST]] command.

2014-05-13T13:56:41Z

Alsroot:

The following diagram shows the full list of objects implemented by the Sugar Network [[Platform Team/Sugar Network/API|API]].

{| border="0"
|- valign="top" align="let"
| [[File:Sugar-Network-diagram.png|200px|thumb|Sugar Network objects]]
|}

<div id="resource-types"></div>

'''Property types'''

Generally, Sugar Network objects' property types correspond to JSON types. The only exceptions mentioned in the following list:

* ''enum'', is an enumerated type when a value is a string from the predefined list of constants;
* ''markdown'', is a string formatted in the [[Wikipedia:Markdown|Markdown]] syntax;
* ''blob'', is a file represented by string value which is a [[Wikipedia:Sha1|SHA-1]] digest of file's content; the file itself can be obtained from the {{Code|'''GET''' /blobs/''DIGEST''}} request;
* ''aggregated'', is a list of JSON objects which has [[Sugar_Network/API#Aggregated_properties|special API]] to treat its items; each aggregated item has a unique identifier; items might be created not only by the object's authors.

<div id="resource-author"></div>

'''Resource.author'''

A dictionary of authors working on the corresponding resource. Keys are Sugar Network ''User'' guids, or, if particular author is not registered in the Sugar Network, full user names. Values are dictionaries with the following keys:

* ''name''<br>Full author's name;
* ''role''<br>An integer which is a bit-wise ORed value of the following constants:
** ''0x1'', author is registered in the Sugar Network (and ''guid'' key is set);
** ''0x10000'', author is the original author of the corresponding resource; if it is not set, user is only a maintainer, e.g., an uploader of a book which has its original authors.

<div id="resource-status"></div>

'''Resource.status'''

This is a system level property which can be set only by node editors. It is a list of "badges" editors set depending on the object quality. Currently supported statuses are:

* ''featured'', the object is popped up by node editors.

<div id="resource-pins"></div>

'''Resource.pins'''

This property makes sense only for objects provided from a [[Sugar_Network/API#Client_proxy|local proxy]]. The property is intended to store local user's preferences or statuses remote object has in local environment. Currently supported values are:

* ''favorite'', set if a user has ''"stared"'' the object;
* ''checkin'', applied to Context objects only, set if a user has ''"pinned"'' the context to keep its most recent version permanently in the local system;
* ''stale'', applied to Context objects only, set if previously checked-in Context might have more fresh releases on the node; it is not possible to filter Contexts by this value;
* ''inprogress'', applied to Context objects only, set if the Context is in the process of downloading content from the node; it is being temporally set before launching the Context or checking it in; it is not possible to filter Contexts by this value.

<div id="context-type"></div>

'''Context.type'''

Context types:
* ''activity'', Sugar activity;
* ''book'', books in various forms;
* ''group'', offline discussion groups;
* ''package'', GNU/Linux package metadata.

<div id="context-releases"></div>

'''Context.releases'''

Contexts with ''activity'' or ''book'' types might have releases, i.e., activity or book versions that users can download. The ''releases'' property is aggregated where each item describes one particular version. There is no need in working with the ''releases'' property directly, there are high-level API commands to [[Sugar_Network/API#Upload_releases|upload]] and [[Sugar_Network/API#Download_releases|download]] releases.

<div id="post-type"></div>

'''Post.type'''

* ''review'', Review the Context;
* ''object'', Object generated by Context application;
* ''question'', Q&A request;
* ''problem'', Problem with the Context;
* ''idea'', An idea fr the Context;
* ''solution'', Solution for question, problem, or, idea;
* ''announce'', General announcement;
* ''notification'', Auto-generated Post for updates within the Context;
* ''post'', General purpose dependent Post.

'''Post.topic'''

Post objects might belong to a topic post. The system design assumes only two-level Posts hierarchy.

Sugar Network/Resources

2014-05-13T13:43:00Z

Alsroot:

File:Sugar-Network-diagram.png

2014-05-13T12:00:01Z

Alsroot: Alsroot uploaded a new version of "File:Sugar-Network-diagram.png"

2014-05-12T08:56:28Z

Alsroot: /* Node statistics */

This page describes the API that Sugar Network clients use to interact with a Sugar Network server. See also a guide to basic Sugar Network [[Sugar_Network/Concept|concepts]] and [[Platform_Team/Sugar_Network/Architecture|its twin page]] for a technical point of view. In addition, visit the [[Sugar_Network|introduction page]].

{{Note/warning|Note|Until announcing API freeze, this document describes the most recent development version of the API.<br>You can find its implementation on the [[#API servers|node-devel.sugarlabs.org]] server.}}

== Overview ==

To better understand this API, see a technical explanation of its [[Platform_Team/Sugar_Network/Architecture#Conceptual_level|conceptual level]] and [[#Sugar_Network_resources|objects model]] in particular.

The API operates with [[Sugar Network]] [[#Sugar_Network_resources|resources]], which are collections of objects. All objects are identified by globally unique identifiers, GUIDs, and available for operation via [[#Base_API|basic actions]]. The API is being provided from a [[#API_servers|node server]] or a [[#Client_API|client]]. While processing requests, API providers generate [[#Notifications|events]].

The API is [[Wikipedia:Restful|RESTful]], and is served via HTTP(S) using [[Wikipedia:Json|JSON]] notation. The common request url format is:

http[s]://''SERVER''[/''RESOURCE''[/''GUID''[/''PROPERTY'']]][?[cmd=''COMMAND''][&''ARGUMENT''=''VALUE''..]]

When:

* {{Code|SERVER}}, [[#API_servers|particular]] Sugar Network API server;
* {{Code|RESOURCE}}, name one of the [[#Sugar_Network_resources|existing]] resources;
* {{Code|GUID}}, the {{Code|RESOURCE}}'s particular object;
* {{Code|PROPERTY}}, particular property of {{Code|GUID}} object;
* {{Code|COMMAND}}, optional command name; combination of HTTP request method ({{Code|GET}}, {{Code|POST}}, {{Code|PUT}}, or, {{Code|DELETE}}) and [possibly empty] {{Code|COMMAND}} composes the requested [[#Actions|action]];
* {{Code|ARGUMENT}}s and {{Code|VALUE}}s depend on the particular [[#Actions|action]].

In most cases, the server replies in JSON notation. If a request fails, the replied JSON object will contain a {{Code|request}} key, with the original request, and {{Code|error}} key, with an error message.

== API servers ==

These are standard Sugar Network API servers publicly available.

* [http://node-devel.sugarlabs.org/ node-devel.sugarlabs.org]<br>Development server which does not contain important data and is free for any experiments (administrative privileges for anonymous users);

* [http://node-testing.sugarlabs.org/ node-testing.sugarlabs.org]<br>Recent stable release with regular data import from the production server; is still free for any experiments;

* [http://node.sugarlabs.org/ node.sugarlabs.org]<br>Production server;

* [http://localhost:5001/ localhost:5001]<br>default url to get access to [[#Client_API|local proxy]] provided from user side application.

== Sugar Network resources ==

{{:Sugar_Network/Resources}}

== Base API ==

List of actions common of all API providers.

<div id="POST"></div>

'''POST''' /''RESOURCE''

Create new resource object.

JSON object keys to send:
* {{Code|''RESOURCE}}'s properties.

JSON object keys to receive:
* {{Code|guid}}, with globally unique identifier that specifies the created object.

<div id="PUT"></div>

'''PUT''' /''RESOURCE''/''GUID''

Modify resource object. By default, might be called only by {{Code|GUID}} creator.

JSON object keys to send:
* {{Code|RESOURCE}}'s properties to modify.

<div id="DELETE"></div>

'''DELETE''' /''RESOURCE''/''GUID''

Delete resource object. Actual object destruction won't happen, the object will be hidden. Garbage collection of hidden objects will be processed by Network administrators. By default, this action may be called only by the {{Code|GUID}} creator.

<div id="GET"></div>

'''GET''' /''RESOURCE''[?offset=''INTEGER''][&limit=''INTEGER''][&query=''STRING''][&reply=''PROP''][&order_by=<nowiki>[+|-]</nowiki>''PROP''][&group_by=''PROP''][&''PROP''=''VALUE''][&''!PROP''=''VALUE'']

Find resource objects.

Where:
* {{Code|offset}}, ''int''<br>start index to return entries from, the default value is {{Code|0}};
* {{Code|limit}}, ''int''<br>do not return more then specified value, maximal and default values are being setup on server side;
* {{Code|query}}, ''str''<br>search request in [http://xapian.org/docs/queryparser.html Xapian] notation with the following additions:
** if property is boolean, integer or datetime, it supports searching by ranges: {{Code|''PROP'':[''START'']..[''END'']}};
** the statement {{Code|''PROP''<nowiki>:=</nowiki>["]''VALUE''["]}} has the same effect as {{Code|QUERY_PROP}}; it is different to regular {{Code|''PROP'':''VALUE''}} where {{Code|VALUE}} might be a substring;
* {{Code|PROP}}, ''str''<br>supplements {{Code|query}} with filtering by exact value of the {{Code|PROP}} property; the resulting query string will be {{Code|''PROP''<nowiki>=</nowiki>''VALUE'' AND (''QUERY'')}}; argument is multiple;
* {{Code|!PROP}}, ''str''<br>supplements {{Code|query}} by excluding exact value of the {{Code|PROP}} property; the resulting query string will be {{Code|NOT ''PROP''<nowiki>=</nowiki>''VALUE'' AND (''QUERY'')}}; argument is multiple;
* {{Code|reply}}, ''str''<br>''RESOURCE'' properties to return; by default, return only {{Code|guid}} property; argument is multiple;
* {{Code|order_by}}, ''str''<br>property to sort the resulting list by; if starts with the {{Code|-}}, the order is descending, otherwise it is ascending;
* {{Code|group_by}}, ''str''<br>property name to group resulting list by.

JSON object keys to receive:
* {{Code|total}}, total number in requested query (the reply might contain only the portion restricted by {{Code|limit}} request argument);
* {{Code|result}}, an array of dictionaries with resource object properties, dictionaries contain at least {{Code|guid}} property.

<div id="GET-resource"></div>

'''GET''' /''RESOURCE''/''GUID''[?reply=''PROP'']

Where:
* {{Code|reply}}, ''str''<br>''RESOURCE'' properties to return; by default, return only {{Code|guid}} property; argument is multiple;

Return properties for a particular resource object.

JSON object keys to receive:
* properties that were specified in {{Code|reply}} argument(s), at least {{Code|guid}}.

<div id="GET-property"></div>

'''GET''' /''RESOURCE''/''GUID''/''PROP''

Return property value for particular resource object.

Data to receive:
* property value in JSON notation for regular properties;
* raw data or redirection for BLOB properties.

=== Aggregated properties ===

[[#resource-types|Aggregated]] properties have special API to treat their content.

<div id="POST-aggproperty"></div>

'''POST''' /''RESOURCE''/''GUID''/''PROP''

Submit new item. The command returns an id for newly created aggregated item. Depending on particular property, new items might be created not only by object's authors.

<div id="PUT-aggproperty"></div>

'''PUT''' /''RESOURCE''/''GUID''/''PROP''/''ID''

Update existing aggregated item. Depending on particular property, the command is allowed either to object's authors or to aggregated item submitter.

<div id="DELETE-aggproperty"></div>

'''DELETE''' /''RESOURCE''/''GUID''/''PROP''/''ID''

Delete existing aggregated item. Depending on particular property, the command is allowed either to object's authors or to aggregated item submitter.

=== Notifications ===

It is possible to subscribe to server events. Notification will happen using HTML5 [[wikipedia:Server-sent_events|Server-sent events]] (SSE).

To start subscription, send the following request:

'''GET''' /?cmd='''subscribe'''

Response will be served with ''text/event-stream'' MIME type for default SSE message type. SSE message will be a JSONified object with the following, at least, attributes:

* {{Code|event}}<br>event type.

== Node API ==

This is an API provided by Sugar Network nodes on top of [[#Base_API|base one]].

=== Authentication ===

Right now, the only way to be authenticated on a Sugar Network server is by running a [[Platform_Team/Sugar_Network/Implementation#sugar-network-client|local application]] on the client side and using the API it [[#Client_API|provides]].

''TODO''

=== Authorization ===

Read-only access is available for anonymous requests, except special content like machine serial numbers. But to process any changes, clients need to be authenticated.

Right after creating any Sugar Network object, its author becomes the only user who can process any object modifications afterwards. Authority information will be kept in the [[#Sugar_Network_resources|author]] property and can be modified using the following commands.

'''PUT''' /''RESOURCE''/''GUID''?cmd='''useradd'''&user=''USER''&role=''ROLE''

Add another user who can modify the corresponding object. ''USER'' argument should be either ''User'' guid (for authors registered in the Sugar Network), or, full author name.

'''PUT''' /''RESOURCE''/''GUID''?cmd='''userdel'''&user=''USER''

Remove user from the authority list. It is not possible to remove yourself. ''USER'' argument should be either ''User'' guid (for authors registered in the Sugar Network), or, full author name.

''TODO''

=== Retrieving releases ===

To easy download Context [[#context-releases|releases]] and avoid reading raw ''Context.releases'' property, there are special high-level API commands.

<div id="GET-solve"></div>

'''GET''' /context/''GUID''?cmd='''solve'''[&lsb_id=''LSB_ID''][&lsb_release=''LSB_RELEASE''][&assume=''DEPENDENCY''-''VERSION'']

The command returns information about what particular releases should be downloaded depending on provided requirements. This command might return not only one release, e.g., activities might have dependencies either system packages or another Sugar Network Contexts.

Solving requirements might be:

* {{Code|LSB_ID}}, if Context releases depend on system packages, specify the [[Wikipedia:Linux_Standard_Base|LSB]] distributor id to consider while choosing particular packages;
* {{Code|LSB_RELEASE}}, if Context releases depend on system packages, specify the [[Wikipedia:Linux_Standard_Base|LSB]] release number of the distribution to consider while choosing particular packages;
* {{Code|DEPENDENCY-VERSION}}, the {{Code|assume}} argument instructs server to assume that specified [[Sugar_Network/Recipe_Specification#Dependencies|dependency]] is already available on client side and should be taken into account while solving; this is especially important for package dependencies when server considers packages available only from official repositories but users might have more recent package versions installed in local system; e.g., the above example request will fail without {{Code|sugar-0.94}} because neither {{Code|lsb_id}} nor {{Code|lsb_release}} were specified (even if LSB information is passed, server might not have information about what package versions come from official repositories).

The resulting info is a JSON object with keys equal to Context guids and value objects for chosen release with the following keys:

* {{Code|blob}}, bundle [[#resource-types|digest]] to download;
* {{Code|version}}, chosen version number;
* {{Code|title}}, the ''Context.title'' value;
* {{Code|command}}, a command to launch the bundle, only for Sugar activities.

For example, the {{Code|'''GET''' <nowiki>/context/org.laptop.TurtleArtActivity?cmd=solve&assume=sugar-0.94</nowiki>}} request returns:

{
"org.laptop.TurtleArtActivity": {
"title": "Turtle Blocks",
"version": [[202], 0],
"blob": "http://download.sugarlabs.org/activities/4027/turtleblocks-202.xo",
"content-type": "application/vnd.olpc-sugar",
"size": 4715955,
"unpack_size": 12873871,
"command": ["activity", "sugar-activity TurtleArtActivity.TurtleArtActivity"],
},
"sugar": {
"version": [[0, 94], 0],
},
}

<div id="GET-clone"></div>

Like the [[#GET-solve|solve]] command, ''clone'' makes a solution but returns bundle itself, so, there is no way to get information about possible dependencies.

'''GET''' /context/''GUID''?cmd='''clone'''[&requires=''DEPENDENCY''][&lsb_id=''LSB_ID''][&lsb_release=''LSB_RELEASE''][&assume=''CONTEXT''-''VERSION'']

=== Upload releases ===

To easy upload Context [[#context-releases|releases]] and avoid writing to raw ''Context.releases'' property, there is a special high-level API command.

'''POST''' /context?cmd='''submit'''[&''PROP''=''VALUE''][&initial]

Where the {{Code|PROP}} arguments are optional release properties. The {{Code|initial}} argument asks the system to create new Context resource new release will belong to.

The posting data might be two types,

* Sugar activities in .xo bundles,<br>there is no need in {{Code|PROP}} arguments, all properties will be populated basing on metadata from a .xo bundle; including release notes from the {{Code|CHANGELOG}} file in [[Wikipedia:Markdown|Markdown]] notation; besides, only in this case {{Code|initial}} makes sense because it is the only way to get Context properties;

* Arbitrary data,<br>all required release properties should be specified in {{Code|PROP}} arguments, at least ''context'' and ''version''; ''license'' should be specified only if there are no existing releases to pickup license from.

=== Node statistics ===

While working, Sugar Network servers collect depersonalized and common [[Sugar_Network/Node_Statistics|statistics]]. To read such info, call the command:

'''GET''' /?cmd='''stats'''&records=''NUMBER''[&start=''SECONDS''][&end=''SECONDS''][&source=''STATS-NAME'']

Where:

* {{Code|records}}, number of stat records to return for the {{Code|start}}-{{Code|end}} interval; note that this amount is not precise, the final resultset might be smaller or bigger depending on chosen resolution; stats resolution depends on node configuration, default values are 1 day, 10 days, 30 days, 365 days;
* {{Code|start}} and {{Code|end}} is a time interval to get statistics for; if omitted, the beginning and the end of entire life cycle will be used;
* {{Code|source}}, multiple argument to specify what [[Sugar_Network/Node_Statistics#Common_statistics|stats]] should be returned; if omitted, return all sources.

== Client API ==

The reasons to proxy Sugar Network data on users side:

* Seamless support [[#Offline mode|offline workflow]];
* [[#Launching|One-click launch]] Sugar activities hosted on Sugar Network.

Proxying happens by providing the same Sugar Network API (with some extra functionality, see below) from
[[Platform_Team/Sugar_Network/Implementation#sugar-network-client|local process]] launched beforehand.

=== Offline mode ===

Being connected to a Sugar Network node, local proxy provides [[#Node_API|original API]] from the node. If the connection is lost, the proxy will switch to local Sugar Network storage and continue working providing only [[#Base_API|base API]]. Any content created in offline mode will be uploaded to the node after getting a connection back.

Besides, local Sugar Network storage will be reused to keep users preferences, such as:

* Favorited Contexts<br>to select preferred ''Context'' resources; these Contexts will be marked by {{Code|favorite}} value in the ''Context.layer'' property;

* Checked-in Contexts<br>to keep most recent Context (for ''activity'' and ''book'' types) version in local storage to make it available in offline; note that there is no need in checking-in to speedup online lunch, versions are being [[#Launching|cached]] anyway; these Contexts will be marked by {{Code|checkin}} value in the ''Context.layer'' property.

To control users preferences there are special API commands:

<div id="PUT_favorite"></div>

'''PUT''' /context/''GUID''?cmd='''favorite'''

Set favorite status.

<div id="DELETE_favorite"></div>

'''DELETE''' /context/''GUID''?cmd='''favorite'''

Unset favorite status.

<div id="PUT_checkin"></div>

'''PUT''' /context/''GUID''?cmd='''checkin'''[&spawn]

Check-in the specified Context. By default, the command will return streamed ''text/event-stream'' MIME type data to monitor the progress. If the {{Code|spawn}} argument is specified, the command will exit immediately with [[#Notifications|asynchronous sending]] progress events.

<div id="DELETE_checkin"></div>

'''DELETE''' /context/''GUID''?cmd='''checkin'''

Checkout the Context.

=== Launching ===

Sugar Network Contexts (for ''activity'' and ''book'' types) can be launched as-is. The launching process is implicit and includes selecting the most recent (and appropriate for software contexts) version, downloading bundles from the Sugar Network, installing missed [[Sugar_Network/Recipe_Specification#Dependencies|software dependencies]], execution itself. All downloaded bundles will be cached [with further garbage collecting] to speedup further launching.

Sugar activities will be directly executed. Book Contexts will be opened in the proper application according to its MIME type.

'''GET''' /context/''GUID''?cmd='''launch'''[&args=''ARG''][&activity_id=''ACTIVITY_ID''][&object_id=''OBJECT_ID''][&uri=''URI''][&app=''APP''][&spawn]

Arguments that make sense only for Sugar activities:

* {{Code|ARG}}, command line argument to pass to launched activities, repeat {{Code|ARG}} for each argument;
* {{Code|ACTIVITY_ID}}, internal activity id which will be auto set if omitted;
* {{Code|OBJECT_ID}}, Journal object id to resume;
* {{Code|URI}}, URL to resume if activity supports this functionality.

Arguments that make sense only for books:

* {{Code|APP}}, specify application Context to open the book by; if omitted, the system will try to find most appropriate option, among all existing software Contexts.

Common arguments:

* {{Code|spawn}}, by default, the command will return streamed ''text/event-stream'' MIME type data to monitor the whole launching process until exiting the application; if the {{Code|spawn}} argument is specified, the command will exit immediately with [[#Notifications|asynchronous sending]] launching events.

== Experimental API ==

There is no guaranty that the following API will be stated as stable or frozen sometime.

=== Access to Sugar Journal ===

It is possible to get access to local Sugar Journal using special, ''journal'', resource provided from [[#Client_API|client API]]. This kind of access might be useful when local applications cannot use DBus sugar-datastore API, e.g., [[wikipedia:Javascript|Javascript]] applications. API to Journal is restricted only to read-only access:

'''GET''' /journal?offset=''INTEGER''&limit=''INTEGER''[&query=''STRING''][&order_by=<nowiki>[+|-]</nowiki>''PROP''][&''QUERY_PROP''=''VALUE''[&...]]
'''GET''' /journal/''JOURNAL_ID''[?reply=''PROP''[,..]]
'''GET''' /journal/''JOURNAL_ID''/''PROPERTY''

== Usage ==

Being HTTP based, Sugar Network API can be used in any manner regular HTTP requests can be handled. But for command-line access, there is a handy tool, {{Code|sugar-network}}, which takes care about Sugar Network specific like launching local API (if it is not already available) to get access to [[#Client_API|local proxy]].

The sugar-network command-line format is below. Call {{Code|sugar-network --help}} for more detailed info.

sugar-network GET|POST|PUT|DELETE ''PATH'' ''ARG=VALUE'' [..]

* {{Code|PATH}}, is an url path;
* {{Code|ARG<nowiki>=</nowiki>VALUE}}, request arguments as they being passed to in url.

{{Code|POST}} and {{Code|PUT}} commands require data to pass, use the following command-line arguments:

* {{Code|-f FILE}} to specify the file to pass;
* {{Code|-d DATA}} to specify string to pass;
* {{Code|-j}} posted data should be encoded into JSON before posting.

== Getting involved ==

{{:Sugar_Network/Feedback}}

Sugar Network/Node Statistics

2014-05-12T03:49:58Z

Alsroot: /* Common statistics */

== Summary ==

This page describes the statistics that [[Sugar Network]] nodes generate. The statistics are about the entire server and not [[Platform_Team/Usage_Statistics|personalized]]. Note that the statistics are targeted for the interests of educational researchers rather than service maintainers, for technical details look for [http://jita.sugarlabs.org/node.sugarlabs.org/ HTTP stats].

Statistics will be collected by analyzing regular requests to an API server and stored for each Sugar Network node. It will be possible to get direct access to these stats using node's [[Sugar_Network/API#Node_statistics|API]].

== Common statistics ==

Statistics will be collected per Sugar Network [[Sugar_Network/Resources|resource type]].

''User''<br>
* '''user.total'''<br>Total number of existing objects.

''Context''<br>
* '''context.total'''<br>Total number of existing objects.
* '''context.released'''<br>Average number of newly uploaded releases for specified time frame;
* '''context.solved'''<br>Average number of requested [[Sugar_Network/API#GET-solve|solutions]] for specified time frame; note that this stats value does not equal to the number of solution usages on client side since solutions might be cached;
* '''context.reported'''<br>Average number of newly uploaded failure ''Reports'' for specified time frame;

''Post''<br>
* '''post.topics'''<br>Total number of top-level ''Post'' objects;
* '''post.feedback'''<br>Total number of dependent ''Post'' objects.

== Per object statistics ==

While calculating [[#Common_statistics|common]] statistics, nodes generate per object sums as well.

These are the Sugar Network [[Sugar_Network/Resources|resources]] that will be affected:

''Context'' properties:
* '''Context.rating'''<br>Average rating given to the ''Context'' while reviewing, rating value is a tuple of votes sum and number of reviews;
* '''Context.retrieves'''<br>Number of retrieves of ''Context'' releases.

''Post'' properties:
* '''Post.rating'''<br>Average rating given to the ''Post'' while reviewing, rating value is a tuple of votes sum and number of reviews.

== Getting involved ==

{{:Sugar_Network/Feedback}}