Back to top

Tin Can Recipes - Interactions

Actors 

An Actor in the interactions recipe is a submitter of an interaction. They are identified here by email address and the mbox value provided in the statements.

Actors List 

Provides access to all of the actors/watchers found by this recipe.

GET All Actors
/actors{?recipeId}
https://server.abc/Recipes/actors?recipeId=http://id.tincanapi.com/recipe/interactions/1
  • Response  200Toggle
  • Headers
    Content-Type: application/json
    Body
    { "results" : [ { "actors" : [ { "mbox" : "mailto:jimmy@testing.com",
              "objectType" : "Agent"
            },
            { "mbox" : "mailto:joe.user.4@testing.com",
              "objectType" : "Agent"
            },
            { "mbox" : "mailto:joe.user.5@testing.com",
              "objectType" : "Agent"
            },
            { "mbox" : "mailto:joe.user3@testing.com",
              "objectType" : "Agent"
            },
            { "mbox" : "mailto:test@tester.com",
              "objectType" : "Agent"
            },
            { "mbox" : "mailto:tester@testing.com",
              "objectType" : "Agent"
            },
            { "mbox" : "mailto:tester2@testing.com",
              "objectType" : "Agent"
            }
          ] } ] }
  • Response  400Toggle
  • Headers
    Content-Type: application/json
    Body
    {"results":[],"error":"recipeId was not supplied in the queryParams"}

Actors by Email 

Provides access to all of the actors/watchers found by this recipe filtered by the provided email fragment.

GET Actors by Email
/actors{?recipeId,email}
https://server.abc/Recipes/actors?recipeId=http://id.tincanapi.com/recipe/interactions/1&email=testing.com
  • Response  200Toggle
  • Headers
    Content-Type: application/json
    Body
    { "results" : [ { "actors" : [ { "mbox" : "mailto:jimmy@testing.com",
              "objectType" : "Agent"
            },
            { "mbox" : "mailto:joe.user.4@testing.com",
              "objectType" : "Agent"
            },
            { "mbox" : "mailto:joe.user.5@testing.com",
              "objectType" : "Agent"
            },
            { "mbox" : "mailto:joe.user3@testing.com",
              "objectType" : "Agent"
            },
            { "mbox" : "mailto:tester@testing.com",
              "objectType" : "Agent"
            },
            { "mbox" : "mailto:tester2@testing.com",
              "objectType" : "Agent"
            }
          ] } ] }
  • Response  400Toggle
  • Headers
    Content-Type: application/json
    Body
    {"results":[],"error":"recipeId was not supplied in the queryParams"}

Objects 

Provides access to all the objects/interactionss found by this recipe. Use this to populate selectors for object/interactions specific queries.

Objects List 

Provides access to all of the actors/watchers found by this recipe.

GET All Objects
/objects{?recipeId}
https://server.abc/Recipes/objects?recipeId=http://id.tincanapi.com/recipe/interactions/1
  • Response  200Toggle
  • Headers
    Content-Type: application/json
    Body
    {"results":[
    {"objectIds":[

    ]
}
]
}
  • Response  400Toggle
  • Headers
    Content-Type: application/json
    Body
    {"results":[],"error":"recipeId was not supplied in the queryParams"}

Results 

Aggregate data from all statements matching the recipe. Perform a pre-defined query on the datastore with optional parameters

Results List 

Get GetInteractions
/results{?recipeId,recipeQueryId,limit,*additional parameters*}
https://server.abc/Recipes/results?recipeQueryId=GetInteractions&recipeId=http://id.tincanapi.com/recipe/interactions/1
  • Parameters
  • recipeId
    URI (required) Example: http://registry.tincanapi.com/recipes/interactions/1
    recipeQueryId
    interactionsQuery (required) Example: GetInteractions

    Choices: GetInteractions

    additionalParams
    queryStringParameter (optional) Example: objectId=123
  • Response  200Toggle
  • Headers
    Content-Type: application/json
    Body
    {"results":
    [
        {}
    ]
}
  • Response  400Toggle
  • Headers
    Content-Type: application/json
    Body
    {"results":[],"error":"recipeId was not supplied in the queryParams"}

Generated by aglio on 06 Aug 2015