Automation

The Automation object

The Automation object looks like this in JSON:

{
    "object": "automation",
    "id": 1,
    "abbrv": "PERSON_CREATED",
    "name": "Person Added",
    "description": "Whenever a new person is added.",
    "module": "people",
    "status": "active",
    "sandbox": true
}

Attribute	Required	Data Type
id	Yes	int
abbrv	No	text (200)
name	No	text (300)
description	No	text (1000)
module	No	enum (admissions, academics, donations, billing, library, bookstore, financial, campus_life, groups, people, users, students, contact_organizations, course_offerings, accounting, financial_aid, forms, integrations, files)
status	No	enum (active, deleted)
sandbox	No	bool

index

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/automations" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET

require 'httparty'
response = HTTParty.get(
 'https://yourschool.populiweb.com/api2/automations',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/automations',
 headers={
  'Authorization': 'Bearer YOUR_POPULI_API_KEY'
 },
)
print(response.json())

using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/automations"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/automations');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);

Example response:

{
    "object": "list",
    "count": 99,
    "results": 99,
    "results_per_page": null,
    "pages": 1,
    "page": 1,
    "offset": 0,
    "has_more": false,
    "data": [
        {
            "object": "automation",
            "id": 352,
            "abbrv": "TERM_UPDATED",
            "name": "Academic Term Updated",
            "description": "Whenever an academic term is updated.",
            "module": "academics",
            "status": "active"
        }
    ],
    "sandbox": true
}

Retrieves all Automation objects.

HTTP Request

GET /automations

Parameters

None

Permissions

One of the following roles is required to call this method:

Staff

show

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/automations/(automation)" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET

require 'httparty'
response = HTTParty.get(
 'https://yourschool.populiweb.com/api2/automations/(automation)',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/automations/(automation)',
 headers={
  'Authorization': 'Bearer YOUR_POPULI_API_KEY'
 },
)
print(response.json())

using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/automations/(automation)"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/automations/(automation)');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);

Example response:

{
    "object": "automation",
    "id": 1,
    "abbrv": "PERSON_CREATED",
    "name": "Person Added",
    "description": "Whenever a new person is added.",
    "module": "people",
    "status": "active",
    "sandbox": true
}

Retrieves a specific Automation object.

HTTP Request

GET /automations/(automation)

Parameters

No additional parameters are needed beyond the ID of the object being requested that appears in the URL.

Permissions

One of the following roles is required to call this method:

Staff