...
Add one or more new objects.
Request Format
| Request | POST /api/v2/objects.json |
|---|---|
Request Body | List of objects |
| Paginated? | No |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| Results Response | Add requests generate a |
| Error Response | Attribute validation failed |
|
Authentication required | ||
| Error Response | Server error |
Example: Add Two New COs
| Code Block |
|---|
POST /registry/api/v2/cos.json
{
"Cos": [
{
"name": "REST Test",
"description": "Test REST API v2",
"status": "Q"
},
{
"name": "REST Test 2",
"description": "Second Test REST API v2",
"status": "A"
}
]
}
200 OK
{
"results": [
{
"error": "Entity save failure (status: \"content\")."
},
{
"id": 142
}
]
} |
...
Remove an object. In most cases, this will execute a "soft" delete, meaning the record is logically deleted but an archived copy remains in the database. See Changelog Behavior for more information.
Request Format
Request |
|
|---|---|
Request Body | None |
| Paginated? | No |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
|
Object deleted | ||
| Error Response |
|
|
Authentication required | ||
| Error Response | Server error |
Edit
Edit an existing object. Note the old values for the object are archived, see Changelog Behavior for more information.
Request Format
| Request | PUT /api/v2/objects/id.json |
|---|---|
Request Body | Object |
| Paginated? | No |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| Update successful | |
| Error Response | Attribute validation failed or id not found |
|
Authentication required | ||
| Error Response | Server error |
Example: Update CO
| Code Block |
|---|
PUT /registry/api/v2/cos/142.json
{
"Cos": {
"name": "REST Test II",
"description": "Second Test REST API v2",
"status": "A"
}
}
200 OK
|
...
Retrieve an existing object.
Request Format
| Request | GET /api/v2/objects/id.json |
|---|---|
| Request Body | None |
| Paginated? | No |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| An array of a single CO object | CO returned |
|
Authentication required | ||
|
| ||
| Error Response | Unknown error |
The response format is the same as for View (all) below, but without pagination metadata.
...
Retrieve all existing objects. This request may be modified by API-specific parameters to filter available results.
Request Format
| Request | GET /api/v2/objects.json |
|---|---|
| Request Body | None |
| Paginated? | Yes |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| An array of a single CO object | CO returned |
|
Authentication required | ||
| Error Response | Unknown error |
For requests that generate response bodies (ie: "View" requests), the format is a responseMeta object holding Response Metadata, followed by a response object named for the model requested. The response object will be a list of data objects, with a unique id field, a set of attributes appropriate for the model, and a meta section with Record Metadata.
...
| API | Version | Available Since* |
|---|---|---|
Address | v0.1 | |
| AttributeEnumeration | v2.0.0 | |
| CO | 2 | v0.1 |
| COU | 2 | v0.2 |
| CoDepartment | v3.1.0 | |
| CoEmailList | v3.1.0 | |
| CoEnrollmentAttribute | v0.6 | |
| CoExtendedAttribute | v0.2 | |
| CoExtendedType | v0.6 | |
| CoGroup | v0.1 | |
| CoGroupMember | v0.1 | |
| CoInvite | v0.1 | |
| CoNavigationLink | v0.8.3 | |
| CoNsfDemographics | v0.4 | |
| CoOrgIdentityLink | v0.2 | |
| CoPerson | v0.1 | |
| CoPersonRole | v0.2 | |
| CoPetition | ||
| CoProvisioningTarget | ||
| CoService | v3.1.0 | |
| CoTAndCAgreement | v2.0.0 | |
| CoTermsAndConditions | v2.0.0 | |
| EmailAddress | v0.1 | |
| HistoryRecord | v0.7 | |
| Identifier | v0.1 | |
| Name | v0.8.3 | |
| NavigationLink | v0.8.3 | |
| Organization | v0.1 | |
| OrgIdentity | v0.2 | |
| TelephoneNumber | v0.1 | |
| Url | v3.1.0 |
...