Endpoints - Admin API 2.0

NOTE: Dev protected to ODS Tools & Ed-Fi All Hands while in 2.x draft status

Below are the endpoints and their request and response objects for v2.0 of the Ed-Fi ODS / API Admin API.

For the most accurate and detailed documentation of active endpoints in a version, configure and launch your application with SwaggerEnabled : true (this is not recommended in production).

All functional endpoints require authentication to access. See Securing Admin API for details.

Endpoint URLs and Schemas

Actions

Click to view /actions endpoints

Endpoint

HTTP Verb

Description

Request Schema

Response Schema (Success)

v2/actions

GET

Retrieves all actions

-

[
  {
    "id": 0
    "name": "string"
    "uri": "string"

}
]

Applications

Click to view /applications endpoints

Endpoint	HTTP Verb	Description	Request Schema	Response Schema (Success)
v2/applications/	GET	Retrieves all applications	-\|	[ { "id": 0, "applicationName": "string", "vendorId": 0, "claimSetName": "string", "profileIds": [], "educationOrganizationIds": [], "odsInstanceId": 0 } ]
v2/applications/{id}	GET	Retrieves a specific application by `id`	-	{ "id": 0, "applicationName": "string", "vendorId": 0, "claimSetName": "string", "profileIds": [], "educationOrganizationIds": [], "odsInstanceId": 0 }
v2/applications/	POST	Creates a new application	{ "applicationName": "string", "vendorId": 0, "claimSetName": "string", "profileIds": [ 0 ], "educationOrganizationIds": [ 0 ], "odsInstanceId": 0 }	{ "id": 0, "key": "string", "secret": "string" }
v2/applications/{id}	PUT	Updates a specific application by `id`	{ "id": 0, "applicationName": "string", "vendorId": 0, "claimSetName": "string", "profileIds": [ 0 ], "educationOrganizationIds": [ 0 ], "odsInstanceId": 0 }	HTTP response as documented below
v2/applications/{id}	DELETE	Deletes an application by `id`	-	HTTP response as documented below
v2/applications/{id}/reset-credential	PUT	Resets an application credentials by `id`	-	{ "id": 0, "key": "string", "secret": "string" }

AuthStrategies

Click to view /authStrategies endpoints

Endpoint

HTTP Verb

Description

Request Schema

Response Schema (Success)

v2/authStrategies

GET

Retrieves all auth strategies

-

[
  {
    "authStrategyId": 0
    "authStrategyName": "string"
    "displayName": "string"

}
]

ClaimSets

Click to view /claimSets endpoints

Note: Property names start with _ represents read-only properties.

Endpoint	HTTP Verb	Description	Request Schema	Response Schema (Success)
v2/claimSets	GET	Retrieves all claimsets	-	[ { "id": 0, "name": "string", "_isSystemReserved": true, "_applications": [] } ]
v2/claimSets	POST	Creates a new claimset.	{ "name": "string"}	{ "id": 0, "name": "string", "_isSystemReserved": false, "_applications": [] }
v2/claimSets/{id}	GET	Retrieves a specific claimset by id	-	{ "id": 0, "name": "string", "_isSystemReserved": false, "_applications": [], "resourceClaims": [ { "id": "string", "name": "string", "read": true, "create": true, "update": true, "delete": true, "_defaultAuthStrategiesForCRUD": [ { "actionName": string, "authStrategies": [], "isInheritedFromParent": true } ], "authStrategyOverridesForCRUD": [ { "actionName": string, "authStrategies": [], "isInheritedFromParent": true } ], "children": [ "list of resource claims" ] } ] }
v2/claimSets/{id}	PUT	Update the claim set name.	{ "id": 0, "name": "string" }	HTTP response as documented below
v2/claimSets/{id}	DELETE	Deletes a claimset by `id`	-	HTTP response as documented below
v2/claimSets/{claimSetId}/resourceClaimActions	POST	Add resourceclaimaction association to claim set. At least one action should be enabled (read, create, update, delete). resouceclaimId is required fields.	{ "resouceclaimId" : 0, "resourceClaimActions": { "read": true, "create": true, "update": true, "delete": true } }	HTTP response as documented below
v2/claimSets/{claimSetId}/ resourceClaimActions/{resourceClaimid}	PUT	Updates the resourceclaimActions to a specific resource claim on a claimset. At least one action should be enabled (read, create, update, delete).	{ "resourceClaimActions": { "read": true, "create": true, "update": true, "delete": true } }	HTTP response as documented below
v2/claimSets/{claimSetId}/resourceClaimActions/ {resourceClaimId}/overrideAuthStrategy	POST	Override the default authorization strategies on provided resource claim for a specific action. ex: actionName = read, authStrategies= [ "Ownershipbased" ]	{ "actionName": string, "authStrategies: [] }	HTTP response as documented below
v2/claimSets/{claimSetId}/resourceClaimActions/ {resourceClaimId}/resetAuthStrategies	POST	Reset to default authorization strategies on provided resource claim.	-	HTTP response as documented below
v2/claimSets/{claimSetId}/ resourceClaimActions/{resourceClaimId}	DELETE	Deletes a resource claims association from a claim set	-	HTTP response as documented below
v2/claimSets/copy	POST	Copy the existing claimset and create new.	{ "originalId": 0, "name": "string" }	HTTP response as documented below
v2/claimSets/import	POST	Import new claimset	{ "name": "string", "resourceClaims": [ { "name": "string", "read": true, "create": true, "update": true, "delete": true, "authStrategyOverridesForCRUD": [ { "actionName": string, "authStrategies": [] } ], "children": [ "list of resource claims" ] } ] }	HTTP response as documented below
v2/claimSets/{id}/export	GET	Retrieves a specific claimset by id	-	{ "id": 0, "name": "string", "_isSystemReserved": false, "_applications": [], "resourceClaims": [ { "id": "string", "name": "string", "read": true, "create": true, "update": true, "delete": true, "_defaultAuthStrategiesForCRUD": [ { "actionName": string, "authStrategies": [], "isInheritedFromParent": true } ], "authStrategyOverridesForCRUD": [ { "actionName": string, "authStrategies": [], "isInheritedFromParent": true } ], "children": [ "list of resource claims" ] } ] }

OdsInstances

Click to view /odsInstances endpoints

Endpoint	HTTP Verb	Description	Request Schema	Response Schema (Success)
v2/odsInstances	GET	Retrieves all ODS Instances	-	[ { "id": 0 "name": "string" "instanceType": "string" } ]
v2/odsInstances/{id}	GET	Retrieves a specific ODS instance by `id`	-	{ "id": 0 "name": "string" "instanceType": "string" }
v2/odsInstances	POST	Creates a new ODS instance. Note: Will validate the connection string to be proper format. All the fields are required.	{ "name": "string" "instanceType": "string", "connectionString": "string" }	HTTP response as documented below
v2/odsInstances/{id}	PUT	Updates a specific ODS instance by id. Note: Will validate the connection string to be proper format. On update the connection string is optional. If user is not intending to update the connection string value as part of update, then empty value will be passed. So that the existing connection string will be retained as plain text or encrypted value.	{ "name": "string" "instanceType": "string", "connectionString": "string" }	HTTP response as documented below
v2/odsInstances/{id}	DELETE	Deletes an ODS instance by id	-	HTTP response as documented below
v2/odsInstances/{id}/applications	GET	Retrieves list of applications assigned to a specific ODS instance.	-	[ { "id": 0, "applicationName": "string", "vendorId": 0, "claimSetName": "string", "profileIds": [], "educationOrganizationIds": [], "odsInstanceId": 0 } ]

OdsInstanceContexts

Click to view /odsInstanceContexts endpoints

Endpoint	HTTP Verb	Description	Request Schema	Response Schema (Success)
v2/odsInstanceContexts	GET	Retrieves all ODS Instance contexts	-	[ { "id": 0, "odsInstanceId": 0, "contextKey": "string" "contextValue": "string" } ]
v2/odsInstanceContexts/{id}	GET	Retrieves a specific ODS instance context by `id`	-	{ "id": 0, "odsInstanceId": 0, "contextKey": "string" "contextValue": "string" }
v2/odsInstanceContexts	POST	Creates a new ODS instance context All the fields are required. ex: contextKey = "SchoolYear" contextValue = "2023"	{ "odsInstanceId": 0 "contextKey": "string", "contextValue": "string" }	HTTP response as documented below
v2/odsInstanceContexts/{id}	PUT	Updates a specific ODS instance context by id.	{ "odsInstanceId": 0 "contextKey": "string", "contextValue": "string" }	HTTP response as documented below
v2/odsInstanceContexts/{id}	DELETE	Deletes an ODS instance context by id	-	HTTP response as documented below

OdsInstanceDerivatives

Click to view /odsInstanceDerivatives endpoints

Endpoint	HTTP Verb	Description	Request Schema	Response Schema (Success)
v2/odsInstanceDerivatives	GET	Retrieves all ODS Instance derivatives	-	[ { "id": 0, "odsInstanceId": 0, "derivativeType": "string" } ]
v2/odsInstanceDerivatives /{id}	GET	Retrieves a specific ODS instance derivative by `id`	-	{ "id": 0, "odsInstanceId": 0, "derivativeType": "string" }
v2/odsInstanceDerivatives	POST	Creates a new ODS instance derivative All the fields are required. Note: Will validate the connection string to be proper format. Derivative types would be "ReadReplica" or "Snapshot"	{ "odsInstanceId": 0 "derivativeType": "string", "connectionString": "string" }	HTTP response as documented below
v2/odsInstanceDerivatives/{id}	PUT	Updates a specific ODS instance derivative by id. Note: Will validate the connection string to be proper format. On update the connection string is optional. If user is not intending to update the connection string value as part of update, then empty value will be passed. So that the existing connection string will be retained as plain text or encrypted value. Derivative types would be "ReadReplica" or "Snapshot"	{ "odsInstanceId": 0 "derivativeType": "string", "connectionString": "string" }	HTTP response as documented below
v2/odsInstanceDerivatives/{id}	DELETE	Deletes an ODS instance derivative by id	-	HTTP response as documented below

Profiles

Click to view /profiles endpoints

Endpoint	HTTP Verb	Description	Request Schema	Response Schema (Success)
v2/profiles	GET	Retrieves all profiles	-	[ { "id": 0, "name":string } ]
v2/profiles	POST	Creates a new profile	`{ "name": "string", "definition": "string" }`	HTTP response as documented below
v2/profiles/{id}	GET	Retrieves a specific profile by `id`	-	{ "id": 0, "name":string, "definition":string }
v2/profiles/{id}	PUT	Updates a specific profile by `id`	`{ "name": "string", "definition": "string" }`	HTTP response as documented below
v2/profiles/{id}	DELETE	Deletes a profile by `id`	-	HTTP response as documented below

ResourceClaims

Click to view /resource claims endpoints

Endpoint HTTP Verb Description Request Schema Response Schema (Success)

v2/resourceClaims

GET

Retrieves all resourceclaims

-

[
  {
    "id": 0
    "name": "string",
    "parentId": null,
    "parentName": "",
    "children": [
      {
       "id": 0
       "name": "string",
       "parentId": 0,
       "parentName": "",
       "children": []
      }
    ]
  }
]

v2/resourceClaims/{id}

GET

Retrieves a specific resource claim by id

-

 {
  "id": 0
  "name": "string",
  "parentId": null,
  "parentName": "",
  "children": [
     {
      "id": 0
      "name": "string",
      "parentId": 0,
      "parentName": "",
      "children": []
     }
  ]
}

Vendors

Click to view /vendors endpoints

Endpoint	HTTP Verb	Description	Request Schema	Response Schema (Success)
v2/vendors	GET	Retrieves all vendors	-	[ { "id": 0, "company": "string", "namespacePrefixes": "string", "contactName": "string", "contactEmailAddress": "string" } ]
v2/vendors	POST	Creates a new vendor	`{ "company": "string", "namespacePrefixes": "string", "contactName": "string", "contactEmailAddress": "string" }`	HTTP response as documented below
v2/vendors/{id}	GET	Retrieves a specific vendor by `id`	-	{ "id": 0, "company": "string", "namespacePrefixes": "string", "contactName": "string", "contactEmailAddress": "string" }
v2/vendors/{id}	PUT	Updates a specific vendor by `id`	`{ "company": "string", "namespacePrefixes": "string", "contactName": "string", "contactEmailAddress": "string" }`	HTTP response as documented below
v2/vendors/{id}	DELETE	Deletes a vendor by `id`	-	HTTP response as documented below
v2/vendors/{id}/applications	GET	Retrieves all applications associated with vendor of `id`	-	[ { "id": 0, "applicationName": "string", "vendorId": 0, "claimSetName": "string", "profileIds": [], "educationOrganizationIds": [], "odsInstanceId": 0 } ]

Common Responses

Response Code	Description	Valid for Verbs	Notes
200 SUCCESS	Request was successful	ALL
201 CREATED	Resource was created successfully	POST	Response will also include a `location` header which directs to the new resource
400 BAD REQUEST	Invalid request payload - See errors for details	POST, PUT
401 UNAUTHORIZED	Missing or invalid authentication token	ALL
403 FORBIDDEN	Authentication token is valid but resource is outside of authenticated scope	ALL
404 NOT FOUND	Resource with given `id` not found	ALL
500 INTERNAL SERVER ERROR	Unexpected error on the system - See error for details	ALL