From 1fb41a232ab35c349404f706f0db76944b624263 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 21 Nov 2024 17:06:04 +0000 Subject: [PATCH 1/5] Add YAML and markdown file api-specification version 2.3.0 --- .../markdown/admin-api-2.3.0-summary.md | 3824 +++++++++++++++++ .../openapi-yaml/admin-api-2.3.0.yaml | 2586 +++++++++++ 2 files changed, 6410 insertions(+) create mode 100644 docs/api-specifications/markdown/admin-api-2.3.0-summary.md create mode 100644 docs/api-specifications/openapi-yaml/admin-api-2.3.0.yaml diff --git a/docs/api-specifications/markdown/admin-api-2.3.0-summary.md b/docs/api-specifications/markdown/admin-api-2.3.0-summary.md new file mode 100644 index 000000000..c0733063e --- /dev/null +++ b/docs/api-specifications/markdown/admin-api-2.3.0-summary.md @@ -0,0 +1,3824 @@ + + +

Admin API Documentation v2

+ +> Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu. + +The Ed-Fi Admin API is a REST API-based administrative interface for managing vendors, applications, client credentials, and authorization rules for accessing an Ed-Fi API. + +# Authentication + +- oAuth2 authentication. + + - Flow: clientCredentials + + - Token URL = [https://localhost/connect/token](https://localhost/connect/token) + +|Scope|Scope Description| +|---|---| +|edfi_admin_api/full_access|Unrestricted access to all Admin API endpoints| + +

ResourceClaims

+ +## Retrieves all resourceClaims. + +`GET /v2/resourceClaims` + +This GET operation provides access to resources using the "Get" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists). + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|offset|query|integer(int32)|false|Indicates how many items should be skipped before returning results.| +|limit|query|integer(int32)|false|Indicates the maximum number of items that should be returned in the results.| +|orderBy|query|string|false|Indicates the property name by which the results will be sorted.| +|direction|query|string|false|Indicates whether the result should be sorted in descending order (DESC) or ascending order (ASC).| +|id|query|integer(int32)|false|Resource Claim Id| +|name|query|string|false|Resource Claim Name| + +#### Enumerated Values + +|Parameter|Value| +|---|---| +|direction|Ascending| +|direction|Descending| + +> Example responses + +> 200 Response + +```json +[ + { + "id": 0, + "name": "string", + "parentId": 0, + "parentName": "string", + "children": [ + {} + ] + } +] +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + +

Response Schema

+ +Status Code **200** + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|*anonymous*|[[resourceClaimModel](#schemaresourceclaimmodel)]|false|none|none| +|» ResourceClaimModel|[resourceClaimModel](#schemaresourceclaimmodel)|false|none|none| +|»» id|integer(int32)|false|none|none| +|»» name|string¦null|false|none|none| +|»» parentId|integer(int32)¦null|false|none|none| +|»» parentName|string¦null|false|none|none| +|»» children|[[resourceClaimModel](#schemaresourceclaimmodel)]¦null|false|none|Children are collection of SimpleResourceClaimModel| +|»»» ResourceClaimModel|[resourceClaimModel](#schemaresourceclaimmodel)|false|none|none| + + + +## Retrieves a specific resourceClaim based on the identifier. + +`GET /v2/resourceClaims/{id}` + +This GET operation provides access to resources using the "Get" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists). + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|id|path|integer(int32)|true|none| + +> Example responses + +> 200 Response + +```json +{ + "id": 0, + "name": "string", + "parentId": 0, + "parentName": "string", + "children": [ + { + "id": 0, + "name": "string", + "parentId": 0, + "parentName": "string", + "children": [] + } + ] +} +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[resourceClaimModel](#schemaresourceclaimmodel)| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not found. A resource with given identifier could not be found.|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + + + +

Vendors

+ +## Retrieves all vendors. + +`GET /v2/vendors` + +This GET operation provides access to resources using the "Get" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists). + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|offset|query|integer(int32)|false|Indicates how many items should be skipped before returning results.| +|limit|query|integer(int32)|false|Indicates the maximum number of items that should be returned in the results.| +|orderBy|query|string|false|Indicates the property name by which the results will be sorted.| +|direction|query|string|false|Indicates whether the result should be sorted in descending order (DESC) or ascending order (ASC).| +|id|query|integer(int32)|false|Vendor/ company id| +|company|query|string|false|Vendor/ company name| +|namespacePrefixes|query|string|false|Namespace prefix for the vendor. Multiple namespace prefixes can be provided as comma separated list if required.| +|contactName|query|string|false|Vendor contact name| +|contactEmailAddress|query|string|false|Vendor contact email id| + +#### Enumerated Values + +|Parameter|Value| +|---|---| +|direction|Ascending| +|direction|Descending| + +> Example responses + +> 200 Response + +```json +[ + { + "id": 0, + "company": "string", + "namespacePrefixes": "string", + "contactName": "string", + "contactEmailAddress": "string" + } +] +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + +

Response Schema

+ +Status Code **200** + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|*anonymous*|[[vendorModel](#schemavendormodel)]|false|none|none| +|» Vendor|[vendorModel](#schemavendormodel)|false|none|none| +|»» id|integer(int32)¦null|false|none|none| +|»» company|string¦null|false|none|none| +|»» namespacePrefixes|string¦null|false|none|none| +|»» contactName|string¦null|false|none|none| +|»» contactEmailAddress|string¦null|false|none|none| + + + +## Creates vendor based on the supplied values. + +`POST /v2/vendors` + +The POST operation can be used to create or update resources. In database terms, this is often referred to as an "upsert" operation (insert + update). Clients should NOT include the resource "id" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used. + +> Body parameter + +```json +{ + "company": "string", + "namespacePrefixes": "string", + "contactName": "string", + "contactEmailAddress": "string" +} +``` + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|body|body|[addVendorRequest](#schemaaddvendorrequest)|true|none| + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|None| +|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request. The request was invalid and cannot be completed. See the response body for details.|None| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + + + +## Retrieves a specific vendor based on the identifier. + +`GET /v2/vendors/{id}` + +This GET operation provides access to resources using the "Get" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists). + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|id|path|integer(int32)|true|none| + +> Example responses + +> 200 Response + +```json +{ + "id": 0, + "company": "string", + "namespacePrefixes": "string", + "contactName": "string", + "contactEmailAddress": "string" +} +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[vendorModel](#schemavendormodel)| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not found. A resource with given identifier could not be found.|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + + + +## Updates vendor based on the resource identifier. + +`PUT /v2/vendors/{id}` + +The PUT operation is used to update a resource by identifier. If the resource identifier ("id") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior. + +> Body parameter + +```json +{ + "company": "string", + "namespacePrefixes": "string", + "contactName": "string", + "contactEmailAddress": "string" +} +``` + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|id|path|integer(int32)|true|none| +|body|body|[editVendorRequest](#schemaeditvendorrequest)|true|none| + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|None| +|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request. The request was invalid and cannot be completed. See the response body for details.|None| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not found. A resource with given identifier could not be found.|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + + + +## Deletes an existing vendor using the resource identifier. + +`DELETE /v2/vendors/{id}` + +The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found). + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|id|path|integer(int32)|true|none| + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Resource was successfully deleted.|None| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not found. A resource with given identifier could not be found.|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + + + +## Retrieves applications assigned to a specific vendor based on the resource identifier. + +`GET /v2/vendors/{id}/applications` + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|id|path|integer(int32)|true|none| + +> Example responses + +> 200 Response + +```json +[ + { + "id": 0, + "applicationName": "string", + "claimSetName": "string", + "educationOrganizationIds": [ + 0 + ], + "vendorId": 0, + "profileIds": [ + 0 + ], + "odsInstanceIds": [ + 0 + ] + } +] +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not found. A resource with given identifier could not be found.|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + +

Response Schema

+ +Status Code **200** + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|*anonymous*|[[applicationModel](#schemaapplicationmodel)]|false|none|none| +|» Application|[applicationModel](#schemaapplicationmodel)|false|none|none| +|»» id|integer(int32)|false|none|none| +|»» applicationName|string¦null|false|none|none| +|»» claimSetName|string¦null|false|none|none| +|»» educationOrganizationIds|[integer]¦null|false|none|none| +|»» vendorId|integer(int32)¦null|false|none|none| +|»» profileIds|[integer]¦null|false|none|none| +|»» odsInstanceIds|[integer]¦null|false|none|none| + + + +

Profiles

+ +## Retrieves all profiles. + +`GET /v2/profiles` + +This GET operation provides access to resources using the "Get" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists). + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|offset|query|integer(int32)|false|Indicates how many items should be skipped before returning results.| +|limit|query|integer(int32)|false|Indicates the maximum number of items that should be returned in the results.| +|orderBy|query|string|false|Indicates the property name by which the results will be sorted.| +|direction|query|string|false|Indicates whether the result should be sorted in descending order (DESC) or ascending order (ASC).| +|id|query|integer(int32)|false|Profile id| +|name|query|string|false|Profile name| + +#### Enumerated Values + +|Parameter|Value| +|---|---| +|direction|Ascending| +|direction|Descending| + +> Example responses + +> 200 Response + +```json +[ + { + "id": 0, + "name": "string" + } +] +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + +

Response Schema

+ +Status Code **200** + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|*anonymous*|[[profileModel](#schemaprofilemodel)]|false|none|none| +|» Profile|[profileModel](#schemaprofilemodel)|false|none|none| +|»» id|integer(int32)¦null|false|none|none| +|»» name|string¦null|false|none|none| + + + +## Creates profile based on the supplied values. + +`POST /v2/profiles` + +The POST operation can be used to create or update resources. In database terms, this is often referred to as an "upsert" operation (insert + update). Clients should NOT include the resource "id" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used. + +> Body parameter + +```json +"{\n \"name\": \"Test-Profile\",\n \"definition\": \"\"\n}" +``` + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|body|body|[addProfileRequest](#schemaaddprofilerequest)|true|none| + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|None| +|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request. The request was invalid and cannot be completed. See the response body for details.|None| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + + + +## Retrieves a specific profile based on the identifier. + +`GET /v2/profiles/{id}` + +This GET operation provides access to resources using the "Get" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists). + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|id|path|integer(int32)|true|none| + +> Example responses + +> 200 Response + +```json +{ + "id": 0, + "name": "string", + "definition": "string" +} +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[profileDetailsModel](#schemaprofiledetailsmodel)| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not found. A resource with given identifier could not be found.|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + + + +## Updates profile based on the resource identifier. + +`PUT /v2/profiles/{id}` + +The PUT operation is used to update a resource by identifier. If the resource identifier ("id") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior. + +> Body parameter + +```json +"{\n \"name\": \"Test-Profile\",\n \"definition\": \"\"\n}" +``` + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|id|path|integer(int32)|true|none| +|body|body|[editProfileRequest](#schemaeditprofilerequest)|true|none| + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|None| +|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request. The request was invalid and cannot be completed. See the response body for details.|None| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not found. A resource with given identifier could not be found.|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + + + +## Deletes an existing profile using the resource identifier. + +`DELETE /v2/profiles/{id}` + +The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found). + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|id|path|integer(int32)|true|none| + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Resource was successfully deleted.|None| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not found. A resource with given identifier could not be found.|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + + + +

OdsInstances

+ +## Retrieves all odsInstances. + +`GET /v2/odsInstances` + +This GET operation provides access to resources using the "Get" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists). + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|offset|query|integer(int32)|false|Indicates how many items should be skipped before returning results.| +|limit|query|integer(int32)|false|Indicates the maximum number of items that should be returned in the results.| +|orderBy|query|string|false|Indicates the property name by which the results will be sorted.| +|direction|query|string|false|Indicates whether the result should be sorted in descending order (DESC) or ascending order (ASC).| +|id|query|integer(int32)|false|List of ODS instance id| +|name|query|string|false|Ods Instance name| +|instanceType|query|string|false|none| + +#### Enumerated Values + +|Parameter|Value| +|---|---| +|direction|Ascending| +|direction|Descending| + +> Example responses + +> 200 Response + +```json +[ + { + "id": 0, + "name": "string", + "instanceType": "string" + } +] +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + +

Response Schema

+ +Status Code **200** + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|*anonymous*|[[odsInstanceModel](#schemaodsinstancemodel)]|false|none|none| +|» OdsInstance|[odsInstanceModel](#schemaodsinstancemodel)|false|none|none| +|»» id|integer(int32)|false|none|none| +|»» name|string¦null|false|none|none| +|»» instanceType|string¦null|false|none|none| + + + +## Creates odsInstance based on the supplied values. + +`POST /v2/odsInstances` + +The POST operation can be used to create or update resources. In database terms, this is often referred to as an "upsert" operation (insert + update). Clients should NOT include the resource "id" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used. + +> Body parameter + +```json +{ + "name": "string", + "instanceType": "string", + "connectionString": "string" +} +``` + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|body|body|[addOdsInstanceRequest](#schemaaddodsinstancerequest)|true|none| + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|None| +|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request. The request was invalid and cannot be completed. See the response body for details.|None| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + + + +## Retrieves a specific odsInstance based on the identifier. + +`GET /v2/odsInstances/{id}` + +This GET operation provides access to resources using the "Get" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists). + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|id|path|integer(int32)|true|none| + +> Example responses + +> 200 Response + +```json +{ + "id": 0, + "name": "string", + "instanceType": "string", + "odsInstanceContexts": [ + { + "id": 0, + "odsInstanceId": 0, + "contextKey": "string", + "contextValue": "string" + } + ], + "odsInstanceDerivatives": [ + { + "id": 0, + "odsInstanceId": 0, + "derivativeType": "string" + } + ] +} +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[odsInstanceDetailModel](#schemaodsinstancedetailmodel)| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not found. A resource with given identifier could not be found.|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + + + +## Updates odsInstance based on the resource identifier. + +`PUT /v2/odsInstances/{id}` + +The PUT operation is used to update a resource by identifier. If the resource identifier ("id") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior. + +> Body parameter + +```json +{ + "name": "string", + "instanceType": "string", + "connectionString": "string" +} +``` + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|id|path|integer(int32)|true|none| +|body|body|[editOdsInstanceRequest](#schemaeditodsinstancerequest)|true|none| + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|None| +|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request. The request was invalid and cannot be completed. See the response body for details.|None| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not found. A resource with given identifier could not be found.|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + + + +## Deletes an existing odsInstance using the resource identifier. + +`DELETE /v2/odsInstances/{id}` + +The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found). + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|id|path|integer(int32)|true|none| + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Resource was successfully deleted.|None| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not found. A resource with given identifier could not be found.|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + + + +## Retrieves applications assigned to a specific ODS instance based on the resource identifier. + +`GET /v2/odsInstances/{id}/applications` + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|id|path|integer(int32)|true|none| + +> Example responses + +> 200 Response + +```json +[ + { + "id": 0, + "applicationName": "string", + "claimSetName": "string", + "educationOrganizationIds": [ + 0 + ], + "vendorId": 0, + "profileIds": [ + 0 + ], + "odsInstanceIds": [ + 0 + ] + } +] +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not found. A resource with given identifier could not be found.|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + +

Response Schema

+ +Status Code **200** + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|*anonymous*|[[applicationModel](#schemaapplicationmodel)]|false|none|none| +|» Application|[applicationModel](#schemaapplicationmodel)|false|none|none| +|»» id|integer(int32)|false|none|none| +|»» applicationName|string¦null|false|none|none| +|»» claimSetName|string¦null|false|none|none| +|»» educationOrganizationIds|[integer]¦null|false|none|none| +|»» vendorId|integer(int32)¦null|false|none|none| +|»» profileIds|[integer]¦null|false|none|none| +|»» odsInstanceIds|[integer]¦null|false|none|none| + + + +

OdsInstanceDerivatives

+ +## Retrieves all odsInstanceDerivatives. + +`GET /v2/odsInstanceDerivatives` + +This GET operation provides access to resources using the "Get" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists). + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|offset|query|integer(int32)|false|Indicates how many items should be skipped before returning results.| +|limit|query|integer(int32)|false|Indicates the maximum number of items that should be returned in the results.| +|orderBy|query|string|false|Indicates the property name by which the results will be sorted.| +|direction|query|string|false|Indicates whether the result should be sorted in descending order (DESC) or ascending order (ASC).| + +#### Enumerated Values + +|Parameter|Value| +|---|---| +|direction|Ascending| +|direction|Descending| + +> Example responses + +> 200 Response + +```json +[ + { + "id": 0, + "odsInstanceId": 0, + "derivativeType": "string" + } +] +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + +

Response Schema

+ +Status Code **200** + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|*anonymous*|[[odsInstanceDerivativeModel](#schemaodsinstancederivativemodel)]|false|none|none| +|» OdsInstanceDerivative|[odsInstanceDerivativeModel](#schemaodsinstancederivativemodel)|false|none|none| +|»» id|integer(int32)|false|none|none| +|»» odsInstanceId|integer(int32)¦null|false|none|none| +|»» derivativeType|string¦null|false|none|none| + + + +## Creates odsInstanceDerivative based on the supplied values. + +`POST /v2/odsInstanceDerivatives` + +The POST operation can be used to create or update resources. In database terms, this is often referred to as an "upsert" operation (insert + update). Clients should NOT include the resource "id" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used. + +> Body parameter + +```json +{ + "odsInstanceId": 0, + "derivativeType": "string", + "connectionString": "string" +} +``` + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|body|body|[addOdsInstanceDerivativeRequest](#schemaaddodsinstancederivativerequest)|true|none| + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|None| +|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request. The request was invalid and cannot be completed. See the response body for details.|None| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + + + +## Retrieves a specific odsInstanceDerivative based on the identifier. + +`GET /v2/odsInstanceDerivatives/{id}` + +This GET operation provides access to resources using the "Get" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists). + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|id|path|integer(int32)|true|none| + +> Example responses + +> 200 Response + +```json +{ + "id": 0, + "odsInstanceId": 0, + "derivativeType": "string" +} +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[odsInstanceDerivativeModel](#schemaodsinstancederivativemodel)| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not found. A resource with given identifier could not be found.|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + + + +## Updates odsInstanceDerivative based on the resource identifier. + +`PUT /v2/odsInstanceDerivatives/{id}` + +The PUT operation is used to update a resource by identifier. If the resource identifier ("id") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior. + +> Body parameter + +```json +{ + "odsInstanceId": 0, + "derivativeType": "string", + "connectionString": "string" +} +``` + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|id|path|integer(int32)|true|none| +|body|body|[editOdsInstanceDerivativeRequest](#schemaeditodsinstancederivativerequest)|true|none| + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|None| +|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request. The request was invalid and cannot be completed. See the response body for details.|None| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not found. A resource with given identifier could not be found.|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + + + +## Deletes an existing odsInstanceDerivative using the resource identifier. + +`DELETE /v2/odsInstanceDerivatives/{id}` + +The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found). + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|id|path|integer(int32)|true|none| + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Resource was successfully deleted.|None| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not found. A resource with given identifier could not be found.|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + + + +

OdsInstanceContexts

+ +## Retrieves all odsInstanceContexts. + +`GET /v2/odsInstanceContexts` + +This GET operation provides access to resources using the "Get" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists). + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|offset|query|integer(int32)|false|Indicates how many items should be skipped before returning results.| +|limit|query|integer(int32)|false|Indicates the maximum number of items that should be returned in the results.| +|orderBy|query|string|false|Indicates the property name by which the results will be sorted.| +|direction|query|string|false|Indicates whether the result should be sorted in descending order (DESC) or ascending order (ASC).| + +#### Enumerated Values + +|Parameter|Value| +|---|---| +|direction|Ascending| +|direction|Descending| + +> Example responses + +> 200 Response + +```json +[ + { + "id": 0, + "odsInstanceId": 0, + "contextKey": "string", + "contextValue": "string" + } +] +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + +

Response Schema

+ +Status Code **200** + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|*anonymous*|[[odsInstanceContextModel](#schemaodsinstancecontextmodel)]|false|none|none| +|» OdsInstanceContext|[odsInstanceContextModel](#schemaodsinstancecontextmodel)|false|none|none| +|»» id|integer(int32)|false|none|none| +|»» odsInstanceId|integer(int32)|false|none|none| +|»» contextKey|string¦null|false|none|none| +|»» contextValue|string¦null|false|none|none| + + + +## Creates odsInstanceContext based on the supplied values. + +`POST /v2/odsInstanceContexts` + +The POST operation can be used to create or update resources. In database terms, this is often referred to as an "upsert" operation (insert + update). Clients should NOT include the resource "id" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used. + +> Body parameter + +```json +{ + "odsInstanceId": 0, + "contextKey": "string", + "contextValue": "string" +} +``` + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|body|body|[addOdsInstanceContextRequest](#schemaaddodsinstancecontextrequest)|true|none| + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|None| +|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request. The request was invalid and cannot be completed. See the response body for details.|None| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + + + +## Retrieves a specific odsInstanceContext based on the identifier. + +`GET /v2/odsInstanceContexts/{id}` + +This GET operation provides access to resources using the "Get" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists). + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|id|path|integer(int32)|true|none| + +> Example responses + +> 200 Response + +```json +{ + "id": 0, + "odsInstanceId": 0, + "contextKey": "string", + "contextValue": "string" +} +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[odsInstanceContextModel](#schemaodsinstancecontextmodel)| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not found. A resource with given identifier could not be found.|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + + + +## Updates odsInstanceContext based on the resource identifier. + +`PUT /v2/odsInstanceContexts/{id}` + +The PUT operation is used to update a resource by identifier. If the resource identifier ("id") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior. + +> Body parameter + +```json +{ + "odsInstanceId": 0, + "contextKey": "string", + "contextValue": "string" +} +``` + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|id|path|integer(int32)|true|none| +|body|body|[editOdsInstanceContextRequest](#schemaeditodsinstancecontextrequest)|true|none| + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|None| +|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request. The request was invalid and cannot be completed. See the response body for details.|None| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not found. A resource with given identifier could not be found.|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + + + +## Deletes an existing odsInstanceContext using the resource identifier. + +`DELETE /v2/odsInstanceContexts/{id}` + +The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found). + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|id|path|integer(int32)|true|none| + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Resource was successfully deleted.|None| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not found. A resource with given identifier could not be found.|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + + + +

ClaimSets

+ +## Exports a specific claimset by id + +`GET /v2/claimSets/{id}/export` + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|id|path|integer(int32)|true|none| + +> Example responses + +> 200 Response + +```json +{ + "id": 0, + "name": "string", + "_isSystemReserved": true, + "_applications": [ + { + "applicationName": "string" + } + ], + "resourceClaims": [ + { + "id": 0, + "name": "string", + "actions": [ + { + "name": "string", + "enabled": true + } + ], + "_defaultAuthorizationStrategiesForCRUD": [ + { + "actionId": 0, + "actionName": "string", + "authorizationStrategies": [ + { + "authStrategyId": 0, + "authStrategyName": "string", + "isInheritedFromParent": true + } + ] + } + ], + "authorizationStrategyOverridesForCRUD": [ + { + "actionId": 0, + "actionName": "string", + "authorizationStrategies": [ + { + "authStrategyId": 0, + "authStrategyName": "string", + "isInheritedFromParent": true + } + ] + } + ], + "children": [ + {} + ] + } + ] +} +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[claimSetDetailsModel](#schemaclaimsetdetailsmodel)| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not found. A resource with given identifier could not be found.|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + + + +## Retrieves all claimSets. + +`GET /v2/claimSets` + +This GET operation provides access to resources using the "Get" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists). + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|offset|query|integer(int32)|false|Indicates how many items should be skipped before returning results.| +|limit|query|integer(int32)|false|Indicates the maximum number of items that should be returned in the results.| +|orderBy|query|string|false|Indicates the property name by which the results will be sorted.| +|direction|query|string|false|Indicates whether the result should be sorted in descending order (DESC) or ascending order (ASC).| +|id|query|integer(int32)|false|Claim set id| +|name|query|string|false|Claim set name| + +#### Enumerated Values + +|Parameter|Value| +|---|---| +|direction|Ascending| +|direction|Descending| + +> Example responses + +> 200 Response + +```json +[ + { + "id": 0, + "name": "string", + "_isSystemReserved": true, + "_applications": [ + { + "applicationName": "string" + } + ] + } +] +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + +

Response Schema

+ +Status Code **200** + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|*anonymous*|[[claimSetModel](#schemaclaimsetmodel)]|false|none|none| +|» ClaimSet|[claimSetModel](#schemaclaimsetmodel)|false|none|none| +|»» id|integer(int32)|false|none|none| +|»» name|string¦null|false|none|none| +|»» _isSystemReserved|boolean|false|read-only|none| +|»» _applications|[[simpleApplicationModel](#schemasimpleapplicationmodel)]¦null|false|read-only|none| +|»»» Application|[simpleApplicationModel](#schemasimpleapplicationmodel)|false|none|none| +|»»»» applicationName|string¦null|false|none|none| + + + +## Creates claimSet based on the supplied values. + +`POST /v2/claimSets` + +The POST operation can be used to create or update resources. In database terms, this is often referred to as an "upsert" operation (insert + update). Clients should NOT include the resource "id" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used. + +> Body parameter + +```json +{ + "name": "string" +} +``` + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|body|body|[addClaimSetRequest](#schemaaddclaimsetrequest)|true|none| + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|None| +|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request. The request was invalid and cannot be completed. See the response body for details.|None| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + + + +## Retrieves a specific claimSet based on the identifier. + +`GET /v2/claimSets/{id}` + +This GET operation provides access to resources using the "Get" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists). + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|id|path|integer(int32)|true|none| + +> Example responses + +> 200 Response + +```json +{ + "id": 0, + "name": "string", + "_isSystemReserved": true, + "_applications": [ + { + "applicationName": "string" + } + ], + "resourceClaims": [ + { + "id": 0, + "name": "string", + "actions": [ + { + "name": "string", + "enabled": true + } + ], + "_defaultAuthorizationStrategiesForCRUD": [ + { + "actionId": 0, + "actionName": "string", + "authorizationStrategies": [ + { + "authStrategyId": 0, + "authStrategyName": "string", + "isInheritedFromParent": true + } + ] + } + ], + "authorizationStrategyOverridesForCRUD": [ + { + "actionId": 0, + "actionName": "string", + "authorizationStrategies": [ + { + "authStrategyId": 0, + "authStrategyName": "string", + "isInheritedFromParent": true + } + ] + } + ], + "children": [ + {} + ] + } + ] +} +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[claimSetDetailsModel](#schemaclaimsetdetailsmodel)| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not found. A resource with given identifier could not be found.|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + + + +## Updates claimSet based on the resource identifier. + +`PUT /v2/claimSets/{id}` + +The PUT operation is used to update a resource by identifier. If the resource identifier ("id") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior. + +> Body parameter + +```json +{ + "name": "string" +} +``` + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|id|path|integer(int32)|true|none| +|body|body|[editClaimSetRequest](#schemaeditclaimsetrequest)|true|none| + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|None| +|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request. The request was invalid and cannot be completed. See the response body for details.|None| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not found. A resource with given identifier could not be found.|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + + + +## Deletes an existing claimSet using the resource identifier. + +`DELETE /v2/claimSets/{id}` + +The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found). + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|id|path|integer(int32)|true|none| + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Resource was successfully deleted.|None| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not found. A resource with given identifier could not be found.|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + + + +## Copies the existing claimset and create a new one. + +`POST /v2/claimSets/copy` + +> Body parameter + +```json +{ + "originalId": 0, + "name": "string" +} +``` + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|body|body|[copyClaimSetRequest](#schemacopyclaimsetrequest)|true|none| + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|None| +|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request. The request was invalid and cannot be completed. See the response body for details.|None| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + + + +## Imports a new claimset + +`POST /v2/claimSets/import` + +> Body parameter + +```json +{ + "name": "string", + "resourceClaims": [ + { + "name": "string", + "actions": [ + { + "name": "string", + "enabled": true + } + ], + "authorizationStrategyOverridesForCRUD": [ + { + "actionId": 0, + "actionName": "string", + "authorizationStrategies": [ + { + "authStrategyId": 0, + "authStrategyName": "string", + "isInheritedFromParent": true + } + ] + } + ], + "children": [ + {} + ] + } + ] +} +``` + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|body|body|[importClaimSetRequest](#schemaimportclaimsetrequest)|true|none| + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|None| +|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request. The request was invalid and cannot be completed. See the response body for details.|None| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + + + +## Overrides the default authorization strategies on provided resource claim for a specific action. + +`POST /v2/claimSets/{claimSetId}/resourceClaimActions/{resourceClaimId}/overrideAuthorizationStrategy` + +Override the default authorization strategies on provided resource claim for a specific action. + +ex: actionName = read, authorizationStrategies= [ "Ownershipbased" ] + +> Body parameter + +```json +{ + "actionName": "string", + "authorizationStrategies": [ + "string" + ] +} +``` + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|claimSetId|path|integer(int32)|true|none| +|resourceClaimId|path|integer(int32)|true|none| +|body|body|[overrideAuthStategyOnClaimSetRequest](#schemaoverrideauthstategyonclaimsetrequest)|true|none| + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|None| +|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request. The request was invalid and cannot be completed. See the response body for details.|None| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not found. A resource with given identifier could not be found.|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + + + +## Resets to default authorization strategies on provided resource claim. + +`POST /v2/claimSets/{claimSetId}/resourceClaimActions/{resourceClaimId}/resetAuthorizationStrategies` + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|claimSetId|path|integer(int32)|true|none| +|resourceClaimId|path|integer(int32)|true|none| + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|None| +|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request. The request was invalid and cannot be completed. See the response body for details.|None| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not found. A resource with given identifier could not be found.|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + + + +## Adds ResourceClaimAction association to a claim set. + +`POST /v2/claimSets/{claimSetId}/resourceClaimActions` + +Add resourceClaimAction association to claim set. At least one action should be enabled. Valid actions are read, create, update, delete, readchanges. +resouceclaimId is required fields. + +> Body parameter + +```json +{ + "resourceClaimId": 0, + "resourceClaimActions": [ + { + "name": "string", + "enabled": true + } + ] +} +``` + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|claimSetId|path|integer(int32)|true|none| +|body|body|[addResourceClaimOnClaimSetRequest](#schemaaddresourceclaimonclaimsetrequest)|true|none| + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|None| +|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request. The request was invalid and cannot be completed. See the response body for details.|None| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not found. A resource with given identifier could not be found.|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + + + +## Updates the ResourceClaimActions to a specific resource claim on a claimset. + +`PUT /v2/claimSets/{claimSetId}/resourceClaimActions/{resourceClaimId}` + +Updates the resourceClaimActions to a specific resource claim on a claimset. At least one action should be enabled. Valid actions are read, create, update, delete, readchanges. + +> Body parameter + +```json +{ + "resourceClaimActions": [ + { + "name": "string", + "enabled": true + } + ] +} +``` + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|claimSetId|path|integer(int32)|true|none| +|resourceClaimId|path|integer(int32)|true|none| +|body|body|[editResourceClaimOnClaimSetRequest](#schemaeditresourceclaimonclaimsetrequest)|true|none| + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|None| +|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request. The request was invalid and cannot be completed. See the response body for details.|None| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not found. A resource with given identifier could not be found.|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + + + +## Deletes a resource claims association from a claimset + +`DELETE /v2/claimSets/{claimSetId}/resourceClaimActions/{resourceClaimId}` + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|claimSetId|path|integer(int32)|true|none| +|resourceClaimId|path|integer(int32)|true|none| + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|None| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not found. A resource with given identifier could not be found.|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + + + +

AuthorizationStrategies

+ +## Retrieves all authorizationStrategies. + +`GET /v2/authorizationStrategies` + +This GET operation provides access to resources using the "Get" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists). + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|offset|query|integer(int32)|false|Indicates how many items should be skipped before returning results.| +|limit|query|integer(int32)|false|Indicates the maximum number of items that should be returned in the results.| +|orderBy|query|string|false|Indicates the property name by which the results will be sorted.| +|direction|query|string|false|Indicates whether the result should be sorted in descending order (DESC) or ascending order (ASC).| + +#### Enumerated Values + +|Parameter|Value| +|---|---| +|direction|Ascending| +|direction|Descending| + +> Example responses + +> 200 Response + +```json +[ + { + "id": 0, + "name": "string", + "displayName": "string" + } +] +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + +

Response Schema

+ +Status Code **200** + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|*anonymous*|[[authorizationStrategyModel](#schemaauthorizationstrategymodel)]|false|none|none| +|» AuthorizationStrategy|[authorizationStrategyModel](#schemaauthorizationstrategymodel)|false|none|none| +|»» id|integer(int32)|false|none|none| +|»» name|string¦null|false|none|none| +|»» displayName|string¦null|false|none|none| + + + +

Applications

+ +## Retrieves all applications. + +`GET /v2/applications` + +This GET operation provides access to resources using the "Get" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists). + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|offset|query|integer(int32)|false|Indicates how many items should be skipped before returning results.| +|limit|query|integer(int32)|false|Indicates the maximum number of items that should be returned in the results.| +|orderBy|query|string|false|Indicates the property name by which the results will be sorted.| +|direction|query|string|false|Indicates whether the result should be sorted in descending order (DESC) or ascending order (ASC).| +|id|query|integer(int32)|false|Application id| +|applicationName|query|string|false|Application name| +|claimsetName|query|string|false|Claim set name| + +#### Enumerated Values + +|Parameter|Value| +|---|---| +|direction|Ascending| +|direction|Descending| + +> Example responses + +> 200 Response + +```json +[ + { + "id": 0, + "applicationName": "string", + "claimSetName": "string", + "educationOrganizationIds": [ + 0 + ], + "vendorId": 0, + "profileIds": [ + 0 + ], + "odsInstanceIds": [ + 0 + ] + } +] +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + +

Response Schema

+ +Status Code **200** + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|*anonymous*|[[applicationModel](#schemaapplicationmodel)]|false|none|none| +|» Application|[applicationModel](#schemaapplicationmodel)|false|none|none| +|»» id|integer(int32)|false|none|none| +|»» applicationName|string¦null|false|none|none| +|»» claimSetName|string¦null|false|none|none| +|»» educationOrganizationIds|[integer]¦null|false|none|none| +|»» vendorId|integer(int32)¦null|false|none|none| +|»» profileIds|[integer]¦null|false|none|none| +|»» odsInstanceIds|[integer]¦null|false|none|none| + + + +## Creates application based on the supplied values. + +`POST /v2/applications` + +The POST operation can be used to create or update resources. In database terms, this is often referred to as an "upsert" operation (insert + update). Clients should NOT include the resource "id" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used. + +> Body parameter + +```json +{ + "applicationName": "string", + "vendorId": 0, + "claimSetName": "string", + "profileIds": [ + 0 + ], + "educationOrganizationIds": [ + 0 + ], + "odsInstanceIds": [ + 0 + ] +} +``` + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|body|body|[addApplicationRequest](#schemaaddapplicationrequest)|true|none| + +> Example responses + +> 201 Response + +```json +{ + "id": 0, + "key": "string", + "secret": "string" +} +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|[applicationResult](#schemaapplicationresult)| +|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request. The request was invalid and cannot be completed. See the response body for details.|None| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + + + +## Retrieves a specific application based on the identifier. + +`GET /v2/applications/{id}` + +This GET operation provides access to resources using the "Get" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists). + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|id|path|integer(int32)|true|none| + +> Example responses + +> 200 Response + +```json +{ + "id": 0, + "applicationName": "string", + "claimSetName": "string", + "educationOrganizationIds": [ + 0 + ], + "vendorId": 0, + "profileIds": [ + 0 + ], + "odsInstanceIds": [ + 0 + ] +} +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[applicationModel](#schemaapplicationmodel)| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not found. A resource with given identifier could not be found.|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + + + +## Updates application based on the resource identifier. + +`PUT /v2/applications/{id}` + +The PUT operation is used to update a resource by identifier. If the resource identifier ("id") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior. + +> Body parameter + +```json +{ + "applicationName": "string", + "vendorId": 0, + "claimSetName": "string", + "profileIds": [ + 0 + ], + "educationOrganizationIds": [ + 0 + ], + "odsInstanceIds": [ + 0 + ] +} +``` + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|id|path|integer(int32)|true|none| +|body|body|[editApplicationRequest](#schemaeditapplicationrequest)|true|none| + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|None| +|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request. The request was invalid and cannot be completed. See the response body for details.|None| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not found. A resource with given identifier could not be found.|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + + + +## Deletes an existing application using the resource identifier. + +`DELETE /v2/applications/{id}` + +The DELETE operation is used to delete an existing resource by identifier. If the resource doesn't exist, an error will result (the resource will not be found). + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|id|path|integer(int32)|true|none| + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Resource was successfully deleted.|None| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not found. A resource with given identifier could not be found.|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + + + +## Reset application credentials. Returns new key and secret. + +`PUT /v2/applications/{id}/reset-credential` + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|id|path|integer(int32)|true|none| + +> Example responses + +> 200 Response + +```json +{ + "id": 0, + "key": "string", + "secret": "string" +} +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[applicationResult](#schemaapplicationresult)| +|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request. The request was invalid and cannot be completed. See the response body for details.|None| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not found. A resource with given identifier could not be found.|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + + + +

Actions

+ +## Retrieves all actions. + +`GET /v2/actions` + +This GET operation provides access to resources using the "Get" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists). + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|offset|query|integer(int32)|false|Indicates how many items should be skipped before returning results.| +|limit|query|integer(int32)|false|Indicates the maximum number of items that should be returned in the results.| +|orderBy|query|string|false|Indicates the property name by which the results will be sorted.| +|direction|query|string|false|Indicates whether the result should be sorted in descending order (DESC) or ascending order (ASC).| +|id|query|integer(int32)|false|Action id| +|name|query|string|false|Action name| + +#### Enumerated Values + +|Parameter|Value| +|---|---| +|direction|Ascending| +|direction|Descending| + +> Example responses + +> 200 Response + +```json +[ + { + "id": 0, + "name": "string", + "uri": "string" + } +] +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline| +|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized. The request requires authentication|None| +|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden. The request is authenticated, but not authorized to access this resource|None| +|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict. The request is authenticated, but it has a conflict with an existing element|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + +

Response Schema

+ +Status Code **200** + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|*anonymous*|[[actionModel](#schemaactionmodel)]|false|none|none| +|» Action|[actionModel](#schemaactionmodel)|false|none|none| +|»» id|integer(int32)|false|none|none| +|»» name|string¦null|false|none|none| +|»» uri|string¦null|false|none|none| + + + +

Information

+ +## Retrieve API informational metadata + +`GET /` + +> Example responses + +> 200 Response + +```json +{ + "version": "string", + "build": "string" +} +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[informationResult](#schemainformationresult)| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|[informationResult](#schemainformationresult)| + + + +

Connect

+ +## Registers new client + +`POST /connect/register` + +Registers new client + +> Body parameter + +```yaml +ClientId: string +ClientSecret: string +DisplayName: string + +``` + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|body|body|object|false|none| +|» ClientId|body|string|false|Client id| +|» ClientSecret|body|string|false|Client secret| +|» DisplayName|body|string|false|Client display name| + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Application registered successfully.|None| +|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request. The request was invalid and cannot be completed. See the response body for details.|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + + + +## Retrieves bearer token + +`POST /connect/token` + +To authenticate Swagger requests, execute using "Authorize" above, not "Try It Out" here. + +> Body parameter + +```yaml +client_id: null +client_secret: null +grant_type: null +scope: string + +``` + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|body|body|object|false|none| +|» client_id|body|string |false|none| +|» client_secret|body|string |false|none| +|» grant_type|body|string |false|none| +|» scope|body|string|false|none| + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Sign-in successful.|None| +|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request. The request was invalid and cannot be completed. See the response body for details.|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + + + +# Schemas + +

actionModel

+ + + + + + +```json +{ + "id": 0, + "name": "string", + "uri": "string" +} + +``` + +Action + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|id|integer(int32)|false|none|none| +|name|string¦null|false|none|none| +|uri|string¦null|false|none|none| + +

addApplicationRequest

+ + + + + + +```json +{ + "applicationName": "string", + "vendorId": 0, + "claimSetName": "string", + "profileIds": [ + 0 + ], + "educationOrganizationIds": [ + 0 + ], + "odsInstanceIds": [ + 0 + ] +} + +``` + +AddApplicationRequest + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|applicationName|string|false|none|Application name| +|vendorId|integer(int32)|false|none|Vendor/ company id| +|claimSetName|string|false|none|Claim set name| +|profileIds|[integer]¦null|false|none|Profile id| +|educationOrganizationIds|[integer]|false|none|Education organization ids| +|odsInstanceIds|[integer]|false|none|List of ODS instance id| + +

addClaimSetRequest

+ + + + + + +```json +{ + "name": "string" +} + +``` + +AddClaimSetRequest + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|name|string|false|none|Claim set name| + +

addOdsInstanceContextRequest

+ + + + + + +```json +{ + "odsInstanceId": 0, + "contextKey": "string", + "contextValue": "string" +} + +``` + +AddOdsInstanceContextRequest + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|odsInstanceId|integer(int32)|false|none|ODS instance context ODS instance id.| +|contextKey|string|false|none|context key.| +|contextValue|string|false|none|context value.| + +

addOdsInstanceDerivativeRequest

+ + + + + + +```json +{ + "odsInstanceId": 0, + "derivativeType": "string", + "connectionString": "string" +} + +``` + +AddOdsInstanceDerivativeRequest + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|odsInstanceId|integer(int32)|false|none|ODS instance derivative ODS instance id.| +|derivativeType|string|false|none|derivative type.| +|connectionString|string|false|none|connection string.| + +

addOdsInstanceRequest

+ + + + + + +```json +{ + "name": "string", + "instanceType": "string", + "connectionString": "string" +} + +``` + +AddOdsInstanceRequest + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|name|string|false|none|Ods Instance name| +|instanceType|string¦null|false|none|Ods Instance type| +|connectionString|string|false|none|Ods Instance connection string| + +

addProfileRequest

+ + + + + + +```json +"{\n \"name\": \"Test-Profile\",\n \"definition\": \"\"\n}" + +``` + +AddProfileRequest + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|name|string|false|none|Profile name| +|definition|string|false|none|Profile definition| + +

addResourceClaimOnClaimSetRequest

+ + + + + + +```json +{ + "resourceClaimId": 0, + "resourceClaimActions": [ + { + "name": "string", + "enabled": true + } + ] +} + +``` + +AddResourceClaimActionsOnClaimSetRequest + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|resourceClaimId|integer(int32)|false|none|ResourceClaim id| +|resourceClaimActions|[[resourceClaimAction](#schemaresourceclaimaction)]|false|none|none| + +

addVendorRequest

+ + + + + + +```json +{ + "company": "string", + "namespacePrefixes": "string", + "contactName": "string", + "contactEmailAddress": "string" +} + +``` + +AddVendorRequest + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|company|string|false|none|Vendor/ company name| +|namespacePrefixes|string|false|none|Namespace prefix for the vendor. Multiple namespace prefixes can be provided as comma separated list if required.| +|contactName|string|false|none|Vendor contact name| +|contactEmailAddress|string|false|none|Vendor contact email id| + +

adminApiError

+ + + + + + +```json +{ + "title": "string", + "errors": [ + "string" + ] +} + +``` + +AdminApiError + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|title|string¦null|false|read-only|none| +|errors|[string]¦null|false|read-only|none| + +

applicationModel

+ + + + + + +```json +{ + "id": 0, + "applicationName": "string", + "claimSetName": "string", + "educationOrganizationIds": [ + 0 + ], + "vendorId": 0, + "profileIds": [ + 0 + ], + "odsInstanceIds": [ + 0 + ] +} + +``` + +Application + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|id|integer(int32)|false|none|none| +|applicationName|string¦null|false|none|none| +|claimSetName|string¦null|false|none|none| +|educationOrganizationIds|[integer]¦null|false|none|none| +|vendorId|integer(int32)¦null|false|none|none| +|profileIds|[integer]¦null|false|none|none| +|odsInstanceIds|[integer]¦null|false|none|none| + +

applicationResult

+ + + + + + +```json +{ + "id": 0, + "key": "string", + "secret": "string" +} + +``` + +ApplicationKeySecret + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|id|integer(int32)|false|none|none| +|key|string¦null|false|none|none| +|secret|string¦null|false|none|none| + +

authorizationStrategy

+ + + + + + +```json +{ + "authStrategyId": 0, + "authStrategyName": "string", + "isInheritedFromParent": true +} + +``` + +ResourceClaimAuthorizationStrategy + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|authStrategyId|integer(int32)|false|none|none| +|authStrategyName|string¦null|false|none|none| +|isInheritedFromParent|boolean|false|none|none| + +

authorizationStrategyModel

+ + + + + + +```json +{ + "id": 0, + "name": "string", + "displayName": "string" +} + +``` + +AuthorizationStrategy + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|id|integer(int32)|false|none|none| +|name|string¦null|false|none|none| +|displayName|string¦null|false|none|none| + +

claimSetDetailsModel

+ + + + + + +```json +{ + "id": 0, + "name": "string", + "_isSystemReserved": true, + "_applications": [ + { + "applicationName": "string" + } + ], + "resourceClaims": [ + { + "id": 0, + "name": "string", + "actions": [ + { + "name": "string", + "enabled": true + } + ], + "_defaultAuthorizationStrategiesForCRUD": [ + { + "actionId": 0, + "actionName": "string", + "authorizationStrategies": [ + { + "authStrategyId": 0, + "authStrategyName": "string", + "isInheritedFromParent": true + } + ] + } + ], + "authorizationStrategyOverridesForCRUD": [ + { + "actionId": 0, + "actionName": "string", + "authorizationStrategies": [ + { + "authStrategyId": 0, + "authStrategyName": "string", + "isInheritedFromParent": true + } + ] + } + ], + "children": [ + {} + ] + } + ] +} + +``` + +ClaimSetWithResources + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|id|integer(int32)|false|none|none| +|name|string¦null|false|none|none| +|_isSystemReserved|boolean|false|read-only|none| +|_applications|[[simpleApplicationModel](#schemasimpleapplicationmodel)]¦null|false|read-only|none| +|resourceClaims|[[claimSetResourceClaimModel](#schemaclaimsetresourceclaimmodel)]¦null|false|none|none| + +

claimSetModel

+ + + + + + +```json +{ + "id": 0, + "name": "string", + "_isSystemReserved": true, + "_applications": [ + { + "applicationName": "string" + } + ] +} + +``` + +ClaimSet + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|id|integer(int32)|false|none|none| +|name|string¦null|false|none|none| +|_isSystemReserved|boolean|false|read-only|none| +|_applications|[[simpleApplicationModel](#schemasimpleapplicationmodel)]¦null|false|read-only|none| + +

claimSetResourceClaimActionAuthStrategies

+ + + + + + +```json +{ + "actionId": 0, + "actionName": "string", + "authorizationStrategies": [ + { + "authStrategyId": 0, + "authStrategyName": "string", + "isInheritedFromParent": true + } + ] +} + +``` + +ClaimSetResourceClaimActionAuthorizationStrategies + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|actionId|integer(int32)¦null|false|none|none| +|actionName|string¦null|false|none|none| +|authorizationStrategies|[[authorizationStrategy](#schemaauthorizationstrategy)]¦null|false|none|none| + +

claimSetResourceClaimModel

+ + + + + + +```json +{ + "id": 0, + "name": "string", + "actions": [ + { + "name": "string", + "enabled": true + } + ], + "_defaultAuthorizationStrategiesForCRUD": [ + { + "actionId": 0, + "actionName": "string", + "authorizationStrategies": [ + { + "authStrategyId": 0, + "authStrategyName": "string", + "isInheritedFromParent": true + } + ] + } + ], + "authorizationStrategyOverridesForCRUD": [ + { + "actionId": 0, + "actionName": "string", + "authorizationStrategies": [ + { + "authStrategyId": 0, + "authStrategyName": "string", + "isInheritedFromParent": true + } + ] + } + ], + "children": [ + { + "id": 0, + "name": "string", + "actions": [ + { + "name": "string", + "enabled": true + } + ], + "_defaultAuthorizationStrategiesForCRUD": [ + { + "actionId": 0, + "actionName": "string", + "authorizationStrategies": [ + { + "authStrategyId": 0, + "authStrategyName": "string", + "isInheritedFromParent": true + } + ] + } + ], + "authorizationStrategyOverridesForCRUD": [ + { + "actionId": 0, + "actionName": "string", + "authorizationStrategies": [ + { + "authStrategyId": 0, + "authStrategyName": "string", + "isInheritedFromParent": true + } + ] + } + ], + "children": [] + } + ] +} + +``` + +ClaimSetResourceClaim + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|id|integer(int32)|false|read-only|none| +|name|string¦null|false|none|none| +|actions|[[resourceClaimAction](#schemaresourceclaimaction)]¦null|false|none|none| +|_defaultAuthorizationStrategiesForCRUD|[[claimSetResourceClaimActionAuthStrategies](#schemaclaimsetresourceclaimactionauthstrategies)]¦null|false|read-only|none| +|authorizationStrategyOverridesForCRUD|[[claimSetResourceClaimActionAuthStrategies](#schemaclaimsetresourceclaimactionauthstrategies)]¦null|false|none|none| +|children|[[claimSetResourceClaimModel](#schemaclaimsetresourceclaimmodel)]¦null|false|none|Children are collection of ResourceClaim| + +

copyClaimSetRequest

+ + + + + + +```json +{ + "originalId": 0, + "name": "string" +} + +``` + +CopyClaimSetRequest + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|originalId|integer(int32)|false|none|ClaimSet id to copy| +|name|string|false|none|New claimset name| + +

editApplicationRequest

+ + + + + + +```json +{ + "applicationName": "string", + "vendorId": 0, + "claimSetName": "string", + "profileIds": [ + 0 + ], + "educationOrganizationIds": [ + 0 + ], + "odsInstanceIds": [ + 0 + ] +} + +``` + +EditApplicationRequest + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|applicationName|string|false|none|Application name| +|vendorId|integer(int32)|false|none|Vendor/ company id| +|claimSetName|string|false|none|Claim set name| +|profileIds|[integer]¦null|false|none|Profile id| +|educationOrganizationIds|[integer]|false|none|Education organization ids| +|odsInstanceIds|[integer]|false|none|List of ODS instance id| + +

editClaimSetRequest

+ + + + + + +```json +{ + "name": "string" +} + +``` + +EditClaimSetRequest + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|name|string|false|none|Claim set name| + +

editOdsInstanceContextRequest

+ + + + + + +```json +{ + "odsInstanceId": 0, + "contextKey": "string", + "contextValue": "string" +} + +``` + +EditOdsInstanceContextRequest + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|odsInstanceId|integer(int32)|false|none|ODS instance context ODS instance id.| +|contextKey|string|false|none|context key.| +|contextValue|string|false|none|context value.| + +

editOdsInstanceDerivativeRequest

+ + + + + + +```json +{ + "odsInstanceId": 0, + "derivativeType": "string", + "connectionString": "string" +} + +``` + +EditOdsInstanceDerivativeRequest + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|odsInstanceId|integer(int32)|false|none|ODS instance derivative ODS instance id.| +|derivativeType|string|false|none|derivative type.| +|connectionString|string|false|none|connection string.| + +

editOdsInstanceRequest

+ + + + + + +```json +{ + "name": "string", + "instanceType": "string", + "connectionString": "string" +} + +``` + +EditOdsInstanceRequest + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|name|string|false|none|Ods Instance name| +|instanceType|string¦null|false|none|Ods Instance type| +|connectionString|string¦null|false|none|Ods Instance connection string| + +

editProfileRequest

+ + + + + + +```json +"{\n \"name\": \"Test-Profile\",\n \"definition\": \"\"\n}" + +``` + +EditProfileRequest + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|name|string|false|none|Profile name| +|definition|string|false|none|Profile definition| + +

editResourceClaimOnClaimSetRequest

+ + + + + + +```json +{ + "resourceClaimActions": [ + { + "name": "string", + "enabled": true + } + ] +} + +``` + +EditResourceClaimActionsOnClaimSetRequest + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|resourceClaimActions|[[resourceClaimAction](#schemaresourceclaimaction)]|false|none|none| + +

editVendorRequest

+ + + + + + +```json +{ + "company": "string", + "namespacePrefixes": "string", + "contactName": "string", + "contactEmailAddress": "string" +} + +``` + +EditVendorRequest + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|company|string|false|none|Vendor/ company name| +|namespacePrefixes|string|false|none|Namespace prefix for the vendor. Multiple namespace prefixes can be provided as comma separated list if required.| +|contactName|string|false|none|Vendor contact name| +|contactEmailAddress|string|false|none|Vendor contact email id| + +

importClaimSetRequest

+ + + + + + +```json +{ + "name": "string", + "resourceClaims": [ + { + "id": 0, + "name": "string", + "actions": [ + { + "name": "string", + "enabled": true + } + ], + "_defaultAuthorizationStrategiesForCRUD": [ + { + "actionId": 0, + "actionName": "string", + "authorizationStrategies": [ + { + "authStrategyId": 0, + "authStrategyName": "string", + "isInheritedFromParent": true + } + ] + } + ], + "authorizationStrategyOverridesForCRUD": [ + { + "actionId": 0, + "actionName": "string", + "authorizationStrategies": [ + { + "authStrategyId": 0, + "authStrategyName": "string", + "isInheritedFromParent": true + } + ] + } + ], + "children": [ + {} + ] + } + ] +} + +``` + +ImportClaimSetRequest + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|name|string|false|none|Claim set name| +|resourceClaims|[[claimSetResourceClaimModel](#schemaclaimsetresourceclaimmodel)]|false|none|Resource Claims| + +

informationResult

+ + + + + + +```json +{ + "version": "string", + "build": "string" +} + +``` + +Information + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|version|string|false|none|Application version| +|build|string|false|none|Build / release version| + +

odsInstanceContextModel

+ + + + + + +```json +{ + "id": 0, + "odsInstanceId": 0, + "contextKey": "string", + "contextValue": "string" +} + +``` + +OdsInstanceContext + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|id|integer(int32)|false|none|none| +|odsInstanceId|integer(int32)|false|none|none| +|contextKey|string¦null|false|none|none| +|contextValue|string¦null|false|none|none| + +

odsInstanceDerivativeModel

+ + + + + + +```json +{ + "id": 0, + "odsInstanceId": 0, + "derivativeType": "string" +} + +``` + +OdsInstanceDerivative + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|id|integer(int32)|false|none|none| +|odsInstanceId|integer(int32)¦null|false|none|none| +|derivativeType|string¦null|false|none|none| + +

odsInstanceDetailModel

+ + + + + + +```json +{ + "id": 0, + "name": "string", + "instanceType": "string", + "odsInstanceContexts": [ + { + "id": 0, + "odsInstanceId": 0, + "contextKey": "string", + "contextValue": "string" + } + ], + "odsInstanceDerivatives": [ + { + "id": 0, + "odsInstanceId": 0, + "derivativeType": "string" + } + ] +} + +``` + +OdsInstanceDetail + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|id|integer(int32)|false|none|none| +|name|string¦null|false|none|none| +|instanceType|string¦null|false|none|none| +|odsInstanceContexts|[[odsInstanceContextModel](#schemaodsinstancecontextmodel)]¦null|false|none|none| +|odsInstanceDerivatives|[[odsInstanceDerivativeModel](#schemaodsinstancederivativemodel)]¦null|false|none|none| + +

odsInstanceModel

+ + + + + + +```json +{ + "id": 0, + "name": "string", + "instanceType": "string" +} + +``` + +OdsInstance + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|id|integer(int32)|false|none|none| +|name|string¦null|false|none|none| +|instanceType|string¦null|false|none|none| + +

overrideAuthStategyOnClaimSetRequest

+ + + + + + +```json +{ + "actionName": "string", + "authorizationStrategies": [ + "string" + ] +} + +``` + +OverrideAuthStategyOnClaimSetRequest + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|actionName|string¦null|false|none|none| +|authorizationStrategies|[string]|false|none|AuthorizationStrategy Names| + +

profileDetailsModel

+ + + + + + +```json +{ + "id": 0, + "name": "string", + "definition": "string" +} + +``` + +ProfileDetails + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|id|integer(int32)¦null|false|none|none| +|name|string¦null|false|none|none| +|definition|string¦null|false|none|none| + +

profileModel

+ + + + + + +```json +{ + "id": 0, + "name": "string" +} + +``` + +Profile + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|id|integer(int32)¦null|false|none|none| +|name|string¦null|false|none|none| + +

registerClientRequest

+ + + + + + +```json +{ + "clientId": "string", + "clientSecret": "string", + "displayName": "string" +} + +``` + +RegisterClientRequest + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|clientId|string|false|none|Client id| +|clientSecret|string|false|none|Client secret| +|displayName|string|false|none|Client display name| + +

resourceClaimAction

+ + + + + + +```json +{ + "name": "string", + "enabled": true +} + +``` + +ResourceClaimAction + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|name|string¦null|false|none|none| +|enabled|boolean|false|none|none| + +

resourceClaimModel

+ + + + + + +```json +{ + "id": 0, + "name": "string", + "parentId": 0, + "parentName": "string", + "children": [ + { + "id": 0, + "name": "string", + "parentId": 0, + "parentName": "string", + "children": [] + } + ] +} + +``` + +ResourceClaimModel + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|id|integer(int32)|false|none|none| +|name|string¦null|false|none|none| +|parentId|integer(int32)¦null|false|none|none| +|parentName|string¦null|false|none|none| +|children|[[resourceClaimModel](#schemaresourceclaimmodel)]¦null|false|none|Children are collection of SimpleResourceClaimModel| + +

simpleApplicationModel

+ + + + + + +```json +{ + "applicationName": "string" +} + +``` + +Application + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|applicationName|string¦null|false|none|none| + +

vendorModel

+ + + + + + +```json +{ + "id": 0, + "company": "string", + "namespacePrefixes": "string", + "contactName": "string", + "contactEmailAddress": "string" +} + +``` + +Vendor + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|id|integer(int32)¦null|false|none|none| +|company|string¦null|false|none|none| +|namespacePrefixes|string¦null|false|none|none| +|contactName|string¦null|false|none|none| +|contactEmailAddress|string¦null|false|none|none| + diff --git a/docs/api-specifications/openapi-yaml/admin-api-2.3.0.yaml b/docs/api-specifications/openapi-yaml/admin-api-2.3.0.yaml new file mode 100644 index 000000000..d802bdb11 --- /dev/null +++ b/docs/api-specifications/openapi-yaml/admin-api-2.3.0.yaml @@ -0,0 +1,2586 @@ +openapi: 3.0.1 +info: + title: Admin API Documentation + description: 'The Ed-Fi Admin API is a REST API-based administrative interface for managing vendors, applications, client credentials, and authorization rules for accessing an Ed-Fi API.' + version: v2 +paths: + /v2/resourceClaims: + get: + tags: + - ResourceClaims + summary: Retrieves all resourceClaims. + description: This GET operation provides access to resources using the "Get" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists). + parameters: + - name: offset + in: query + description: Indicates how many items should be skipped before returning results. + schema: + type: integer + format: int32 + default: '0' + - name: limit + in: query + description: Indicates the maximum number of items that should be returned in the results. + schema: + type: integer + format: int32 + default: '25' + - name: orderBy + in: query + description: Indicates the property name by which the results will be sorted. + schema: + type: string + default: '' + - name: direction + in: query + description: Indicates whether the result should be sorted in descending order (DESC) or ascending order (ASC). + schema: + title: Indicates whether the result should be sorted in descending order (DESC) or ascending order (ASC). + enum: + - Ascending + - Descending + type: string + default: Descending + - name: id + in: query + description: Resource Claim Id + schema: + type: integer + format: int32 + - name: name + in: query + description: Resource Claim Name + schema: + type: string + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/resourceClaimModel' + '/v2/resourceClaims/{id}': + get: + tags: + - ResourceClaims + summary: Retrieves a specific resourceClaim based on the identifier. + description: This GET operation provides access to resources using the "Get" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists). + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '404': + description: Not found. A resource with given identifier could not be found. + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/resourceClaimModel' + /v2/vendors: + get: + tags: + - Vendors + summary: Retrieves all vendors. + description: This GET operation provides access to resources using the "Get" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists). + parameters: + - name: offset + in: query + description: Indicates how many items should be skipped before returning results. + schema: + type: integer + format: int32 + default: '0' + - name: limit + in: query + description: Indicates the maximum number of items that should be returned in the results. + schema: + type: integer + format: int32 + default: '25' + - name: orderBy + in: query + description: Indicates the property name by which the results will be sorted. + schema: + type: string + default: '' + - name: direction + in: query + description: Indicates whether the result should be sorted in descending order (DESC) or ascending order (ASC). + schema: + title: Indicates whether the result should be sorted in descending order (DESC) or ascending order (ASC). + enum: + - Ascending + - Descending + type: string + default: Descending + - name: id + in: query + description: Vendor/ company id + schema: + type: integer + format: int32 + - name: company + in: query + description: Vendor/ company name + schema: + type: string + - name: namespacePrefixes + in: query + description: Namespace prefix for the vendor. Multiple namespace prefixes can be provided as comma separated list if required. + schema: + type: string + - name: contactName + in: query + description: Vendor contact name + schema: + type: string + - name: contactEmailAddress + in: query + description: Vendor contact email id + schema: + type: string + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/vendorModel' + post: + tags: + - Vendors + summary: Creates vendor based on the supplied values. + description: 'The POST operation can be used to create or update resources. In database terms, this is often referred to as an "upsert" operation (insert + update). Clients should NOT include the resource "id" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/addVendorRequest' + required: true + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '400': + description: Bad Request. The request was invalid and cannot be completed. See the response body for details. + '201': + description: Created + '/v2/vendors/{id}': + get: + tags: + - Vendors + summary: Retrieves a specific vendor based on the identifier. + description: This GET operation provides access to resources using the "Get" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists). + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '404': + description: Not found. A resource with given identifier could not be found. + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/vendorModel' + put: + tags: + - Vendors + summary: Updates vendor based on the resource identifier. + description: 'The PUT operation is used to update a resource by identifier. If the resource identifier ("id") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.' + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/editVendorRequest' + required: true + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '404': + description: Not found. A resource with given identifier could not be found. + '400': + description: Bad Request. The request was invalid and cannot be completed. See the response body for details. + '200': + description: OK + delete: + tags: + - Vendors + summary: Deletes an existing vendor using the resource identifier. + description: 'The DELETE operation is used to delete an existing resource by identifier. If the resource doesn''t exist, an error will result (the resource will not be found).' + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '404': + description: Not found. A resource with given identifier could not be found. + '200': + description: Resource was successfully deleted. + /v2/profiles: + get: + tags: + - Profiles + summary: Retrieves all profiles. + description: This GET operation provides access to resources using the "Get" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists). + parameters: + - name: offset + in: query + description: Indicates how many items should be skipped before returning results. + schema: + type: integer + format: int32 + default: '0' + - name: limit + in: query + description: Indicates the maximum number of items that should be returned in the results. + schema: + type: integer + format: int32 + default: '25' + - name: orderBy + in: query + description: Indicates the property name by which the results will be sorted. + schema: + type: string + default: '' + - name: direction + in: query + description: Indicates whether the result should be sorted in descending order (DESC) or ascending order (ASC). + schema: + title: Indicates whether the result should be sorted in descending order (DESC) or ascending order (ASC). + enum: + - Ascending + - Descending + type: string + default: Descending + - name: id + in: query + description: Profile id + schema: + type: integer + format: int32 + - name: name + in: query + description: Profile name + schema: + type: string + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/profileModel' + post: + tags: + - Profiles + summary: Creates profile based on the supplied values. + description: 'The POST operation can be used to create or update resources. In database terms, this is often referred to as an "upsert" operation (insert + update). Clients should NOT include the resource "id" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/addProfileRequest' + required: true + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '400': + description: Bad Request. The request was invalid and cannot be completed. See the response body for details. + '201': + description: Created + '/v2/profiles/{id}': + get: + tags: + - Profiles + summary: Retrieves a specific profile based on the identifier. + description: This GET operation provides access to resources using the "Get" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists). + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '404': + description: Not found. A resource with given identifier could not be found. + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/profileDetailsModel' + put: + tags: + - Profiles + summary: Updates profile based on the resource identifier. + description: 'The PUT operation is used to update a resource by identifier. If the resource identifier ("id") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.' + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/editProfileRequest' + required: true + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '404': + description: Not found. A resource with given identifier could not be found. + '400': + description: Bad Request. The request was invalid and cannot be completed. See the response body for details. + '200': + description: OK + delete: + tags: + - Profiles + summary: Deletes an existing profile using the resource identifier. + description: 'The DELETE operation is used to delete an existing resource by identifier. If the resource doesn''t exist, an error will result (the resource will not be found).' + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '404': + description: Not found. A resource with given identifier could not be found. + '200': + description: Resource was successfully deleted. + /v2/odsInstances: + get: + tags: + - OdsInstances + summary: Retrieves all odsInstances. + description: This GET operation provides access to resources using the "Get" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists). + parameters: + - name: offset + in: query + description: Indicates how many items should be skipped before returning results. + schema: + type: integer + format: int32 + default: '0' + - name: limit + in: query + description: Indicates the maximum number of items that should be returned in the results. + schema: + type: integer + format: int32 + default: '25' + - name: orderBy + in: query + description: Indicates the property name by which the results will be sorted. + schema: + type: string + default: '' + - name: direction + in: query + description: Indicates whether the result should be sorted in descending order (DESC) or ascending order (ASC). + schema: + title: Indicates whether the result should be sorted in descending order (DESC) or ascending order (ASC). + enum: + - Ascending + - Descending + type: string + default: Descending + - name: id + in: query + description: List of ODS instance id + schema: + type: integer + format: int32 + - name: name + in: query + description: Ods Instance name + schema: + type: string + - name: instanceType + in: query + schema: + type: string + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/odsInstanceModel' + post: + tags: + - OdsInstances + summary: Creates odsInstance based on the supplied values. + description: 'The POST operation can be used to create or update resources. In database terms, this is often referred to as an "upsert" operation (insert + update). Clients should NOT include the resource "id" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/addOdsInstanceRequest' + required: true + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '400': + description: Bad Request. The request was invalid and cannot be completed. See the response body for details. + '201': + description: Created + '/v2/odsInstances/{id}': + get: + tags: + - OdsInstances + summary: Retrieves a specific odsInstance based on the identifier. + description: This GET operation provides access to resources using the "Get" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists). + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '404': + description: Not found. A resource with given identifier could not be found. + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/odsInstanceDetailModel' + put: + tags: + - OdsInstances + summary: Updates odsInstance based on the resource identifier. + description: 'The PUT operation is used to update a resource by identifier. If the resource identifier ("id") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.' + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/editOdsInstanceRequest' + required: true + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '404': + description: Not found. A resource with given identifier could not be found. + '400': + description: Bad Request. The request was invalid and cannot be completed. See the response body for details. + '200': + description: OK + delete: + tags: + - OdsInstances + summary: Deletes an existing odsInstance using the resource identifier. + description: 'The DELETE operation is used to delete an existing resource by identifier. If the resource doesn''t exist, an error will result (the resource will not be found).' + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '404': + description: Not found. A resource with given identifier could not be found. + '200': + description: Resource was successfully deleted. + /v2/odsInstanceDerivatives: + get: + tags: + - OdsInstanceDerivatives + summary: Retrieves all odsInstanceDerivatives. + description: This GET operation provides access to resources using the "Get" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists). + parameters: + - name: offset + in: query + description: Indicates how many items should be skipped before returning results. + schema: + type: integer + format: int32 + default: '0' + - name: limit + in: query + description: Indicates the maximum number of items that should be returned in the results. + schema: + type: integer + format: int32 + default: '25' + - name: orderBy + in: query + description: Indicates the property name by which the results will be sorted. + schema: + type: string + default: '' + - name: direction + in: query + description: Indicates whether the result should be sorted in descending order (DESC) or ascending order (ASC). + schema: + title: Indicates whether the result should be sorted in descending order (DESC) or ascending order (ASC). + enum: + - Ascending + - Descending + type: string + default: Descending + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/odsInstanceDerivativeModel' + post: + tags: + - OdsInstanceDerivatives + summary: Creates odsInstanceDerivative based on the supplied values. + description: 'The POST operation can be used to create or update resources. In database terms, this is often referred to as an "upsert" operation (insert + update). Clients should NOT include the resource "id" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/addOdsInstanceDerivativeRequest' + required: true + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '400': + description: Bad Request. The request was invalid and cannot be completed. See the response body for details. + '201': + description: Created + '/v2/odsInstanceDerivatives/{id}': + get: + tags: + - OdsInstanceDerivatives + summary: Retrieves a specific odsInstanceDerivative based on the identifier. + description: This GET operation provides access to resources using the "Get" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists). + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '404': + description: Not found. A resource with given identifier could not be found. + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/odsInstanceDerivativeModel' + put: + tags: + - OdsInstanceDerivatives + summary: Updates odsInstanceDerivative based on the resource identifier. + description: 'The PUT operation is used to update a resource by identifier. If the resource identifier ("id") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.' + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/editOdsInstanceDerivativeRequest' + required: true + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '404': + description: Not found. A resource with given identifier could not be found. + '400': + description: Bad Request. The request was invalid and cannot be completed. See the response body for details. + '200': + description: OK + delete: + tags: + - OdsInstanceDerivatives + summary: Deletes an existing odsInstanceDerivative using the resource identifier. + description: 'The DELETE operation is used to delete an existing resource by identifier. If the resource doesn''t exist, an error will result (the resource will not be found).' + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '404': + description: Not found. A resource with given identifier could not be found. + '200': + description: Resource was successfully deleted. + /v2/odsInstanceContexts: + get: + tags: + - OdsInstanceContexts + summary: Retrieves all odsInstanceContexts. + description: This GET operation provides access to resources using the "Get" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists). + parameters: + - name: offset + in: query + description: Indicates how many items should be skipped before returning results. + schema: + type: integer + format: int32 + default: '0' + - name: limit + in: query + description: Indicates the maximum number of items that should be returned in the results. + schema: + type: integer + format: int32 + default: '25' + - name: orderBy + in: query + description: Indicates the property name by which the results will be sorted. + schema: + type: string + default: '' + - name: direction + in: query + description: Indicates whether the result should be sorted in descending order (DESC) or ascending order (ASC). + schema: + title: Indicates whether the result should be sorted in descending order (DESC) or ascending order (ASC). + enum: + - Ascending + - Descending + type: string + default: Descending + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/odsInstanceContextModel' + post: + tags: + - OdsInstanceContexts + summary: Creates odsInstanceContext based on the supplied values. + description: 'The POST operation can be used to create or update resources. In database terms, this is often referred to as an "upsert" operation (insert + update). Clients should NOT include the resource "id" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/addOdsInstanceContextRequest' + required: true + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '400': + description: Bad Request. The request was invalid and cannot be completed. See the response body for details. + '201': + description: Created + '/v2/odsInstanceContexts/{id}': + get: + tags: + - OdsInstanceContexts + summary: Retrieves a specific odsInstanceContext based on the identifier. + description: This GET operation provides access to resources using the "Get" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists). + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '404': + description: Not found. A resource with given identifier could not be found. + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/odsInstanceContextModel' + put: + tags: + - OdsInstanceContexts + summary: Updates odsInstanceContext based on the resource identifier. + description: 'The PUT operation is used to update a resource by identifier. If the resource identifier ("id") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.' + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/editOdsInstanceContextRequest' + required: true + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '404': + description: Not found. A resource with given identifier could not be found. + '400': + description: Bad Request. The request was invalid and cannot be completed. See the response body for details. + '200': + description: OK + delete: + tags: + - OdsInstanceContexts + summary: Deletes an existing odsInstanceContext using the resource identifier. + description: 'The DELETE operation is used to delete an existing resource by identifier. If the resource doesn''t exist, an error will result (the resource will not be found).' + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '404': + description: Not found. A resource with given identifier could not be found. + '200': + description: Resource was successfully deleted. + '/v2/claimSets/{id}/export': + get: + tags: + - ClaimSets + summary: Exports a specific claimset by id + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '404': + description: Not found. A resource with given identifier could not be found. + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/claimSetDetailsModel' + /v2/claimSets: + get: + tags: + - ClaimSets + summary: Retrieves all claimSets. + description: This GET operation provides access to resources using the "Get" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists). + parameters: + - name: offset + in: query + description: Indicates how many items should be skipped before returning results. + schema: + type: integer + format: int32 + default: '0' + - name: limit + in: query + description: Indicates the maximum number of items that should be returned in the results. + schema: + type: integer + format: int32 + default: '25' + - name: orderBy + in: query + description: Indicates the property name by which the results will be sorted. + schema: + type: string + default: '' + - name: direction + in: query + description: Indicates whether the result should be sorted in descending order (DESC) or ascending order (ASC). + schema: + title: Indicates whether the result should be sorted in descending order (DESC) or ascending order (ASC). + enum: + - Ascending + - Descending + type: string + default: Descending + - name: id + in: query + description: Claim set id + schema: + type: integer + format: int32 + - name: name + in: query + description: Claim set name + schema: + type: string + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/claimSetModel' + post: + tags: + - ClaimSets + summary: Creates claimSet based on the supplied values. + description: 'The POST operation can be used to create or update resources. In database terms, this is often referred to as an "upsert" operation (insert + update). Clients should NOT include the resource "id" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/addClaimSetRequest' + required: true + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '400': + description: Bad Request. The request was invalid and cannot be completed. See the response body for details. + '201': + description: Created + '/v2/claimSets/{id}': + get: + tags: + - ClaimSets + summary: Retrieves a specific claimSet based on the identifier. + description: This GET operation provides access to resources using the "Get" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists). + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '404': + description: Not found. A resource with given identifier could not be found. + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/claimSetDetailsModel' + put: + tags: + - ClaimSets + summary: Updates claimSet based on the resource identifier. + description: 'The PUT operation is used to update a resource by identifier. If the resource identifier ("id") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.' + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/editClaimSetRequest' + required: true + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '404': + description: Not found. A resource with given identifier could not be found. + '400': + description: Bad Request. The request was invalid and cannot be completed. See the response body for details. + '200': + description: OK + delete: + tags: + - ClaimSets + summary: Deletes an existing claimSet using the resource identifier. + description: 'The DELETE operation is used to delete an existing resource by identifier. If the resource doesn''t exist, an error will result (the resource will not be found).' + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '404': + description: Not found. A resource with given identifier could not be found. + '200': + description: Resource was successfully deleted. + /v2/authorizationStrategies: + get: + tags: + - AuthorizationStrategies + summary: Retrieves all authorizationStrategies. + description: This GET operation provides access to resources using the "Get" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists). + parameters: + - name: offset + in: query + description: Indicates how many items should be skipped before returning results. + schema: + type: integer + format: int32 + default: '0' + - name: limit + in: query + description: Indicates the maximum number of items that should be returned in the results. + schema: + type: integer + format: int32 + default: '25' + - name: orderBy + in: query + description: Indicates the property name by which the results will be sorted. + schema: + type: string + default: '' + - name: direction + in: query + description: Indicates whether the result should be sorted in descending order (DESC) or ascending order (ASC). + schema: + title: Indicates whether the result should be sorted in descending order (DESC) or ascending order (ASC). + enum: + - Ascending + - Descending + type: string + default: Descending + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/authorizationStrategyModel' + /v2/applications: + get: + tags: + - Applications + summary: Retrieves all applications. + description: This GET operation provides access to resources using the "Get" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists). + parameters: + - name: offset + in: query + description: Indicates how many items should be skipped before returning results. + schema: + type: integer + format: int32 + default: '0' + - name: limit + in: query + description: Indicates the maximum number of items that should be returned in the results. + schema: + type: integer + format: int32 + default: '25' + - name: orderBy + in: query + description: Indicates the property name by which the results will be sorted. + schema: + type: string + default: '' + - name: direction + in: query + description: Indicates whether the result should be sorted in descending order (DESC) or ascending order (ASC). + schema: + title: Indicates whether the result should be sorted in descending order (DESC) or ascending order (ASC). + enum: + - Ascending + - Descending + type: string + default: Descending + - name: id + in: query + description: Application id + schema: + type: integer + format: int32 + - name: applicationName + in: query + description: Application name + schema: + type: string + - name: claimsetName + in: query + description: Claim set name + schema: + type: string + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/applicationModel' + post: + tags: + - Applications + summary: Creates application based on the supplied values. + description: 'The POST operation can be used to create or update resources. In database terms, this is often referred to as an "upsert" operation (insert + update). Clients should NOT include the resource "id" in the JSON body because it will result in an error. The web service will identify whether the resource already exists based on the natural key values provided, and update or create the resource appropriately. It is recommended to use POST for both create and update except while updating natural key of a resource in which case PUT operation must be used.' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/addApplicationRequest' + required: true + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '400': + description: Bad Request. The request was invalid and cannot be completed. See the response body for details. + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/applicationResult' + '/v2/applications/{id}': + get: + tags: + - Applications + summary: Retrieves a specific application based on the identifier. + description: This GET operation provides access to resources using the "Get" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists). + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '404': + description: Not found. A resource with given identifier could not be found. + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/applicationModel' + put: + tags: + - Applications + summary: Updates application based on the resource identifier. + description: 'The PUT operation is used to update a resource by identifier. If the resource identifier ("id") is provided in the JSON body, it will be ignored. Additionally, this API resource is not configured for cascading natural key updates. Natural key values for this resource cannot be changed using PUT operation, so the recommendation is to use POST as that supports upsert behavior.' + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/editApplicationRequest' + required: true + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '404': + description: Not found. A resource with given identifier could not be found. + '400': + description: Bad Request. The request was invalid and cannot be completed. See the response body for details. + '200': + description: OK + delete: + tags: + - Applications + summary: Deletes an existing application using the resource identifier. + description: 'The DELETE operation is used to delete an existing resource by identifier. If the resource doesn''t exist, an error will result (the resource will not be found).' + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '404': + description: Not found. A resource with given identifier could not be found. + '200': + description: Resource was successfully deleted. + '/v2/odsInstances/{id}/applications': + get: + tags: + - OdsInstances + summary: Retrieves applications assigned to a specific ODS instance based on the resource identifier. + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '404': + description: Not found. A resource with given identifier could not be found. + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/applicationModel' + '/v2/vendors/{id}/applications': + get: + tags: + - Vendors + summary: Retrieves applications assigned to a specific vendor based on the resource identifier. + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '404': + description: Not found. A resource with given identifier could not be found. + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/applicationModel' + /v2/actions: + get: + tags: + - Actions + summary: Retrieves all actions. + description: This GET operation provides access to resources using the "Get" search pattern. The values of any properties of the resource that are specified will be used to return all matching results (if it exists). + parameters: + - name: offset + in: query + description: Indicates how many items should be skipped before returning results. + schema: + type: integer + format: int32 + default: '0' + - name: limit + in: query + description: Indicates the maximum number of items that should be returned in the results. + schema: + type: integer + format: int32 + default: '25' + - name: orderBy + in: query + description: Indicates the property name by which the results will be sorted. + schema: + type: string + default: '' + - name: direction + in: query + description: Indicates whether the result should be sorted in descending order (DESC) or ascending order (ASC). + schema: + title: Indicates whether the result should be sorted in descending order (DESC) or ascending order (ASC). + enum: + - Ascending + - Descending + type: string + default: Descending + - name: id + in: query + description: Action id + schema: + type: integer + format: int32 + - name: name + in: query + description: Action name + schema: + type: string + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '200': + description: OK + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/actionModel' + /: + get: + tags: + - Information + summary: Retrieve API informational metadata + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/informationResult' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + content: + application/json: + schema: + $ref: '#/components/schemas/informationResult' + /v2/claimSets/copy: + post: + tags: + - ClaimSets + summary: Copies the existing claimset and create a new one. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/copyClaimSetRequest' + required: true + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '400': + description: Bad Request. The request was invalid and cannot be completed. See the response body for details. + '201': + description: Created + /v2/claimSets/import: + post: + tags: + - ClaimSets + summary: Imports a new claimset + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/importClaimSetRequest' + required: true + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '400': + description: Bad Request. The request was invalid and cannot be completed. See the response body for details. + '201': + description: Created + '/v2/claimSets/{claimSetId}/resourceClaimActions/{resourceClaimId}/overrideAuthorizationStrategy': + post: + tags: + - ClaimSets + summary: Overrides the default authorization strategies on provided resource claim for a specific action. + description: "Override the default authorization strategies on provided resource claim for a specific action.\r\n\r\nex: actionName = read, authorizationStrategies= [ \"Ownershipbased\" ]" + parameters: + - name: claimSetId + in: path + required: true + schema: + type: integer + format: int32 + - name: resourceClaimId + in: path + required: true + schema: + type: integer + format: int32 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/overrideAuthStategyOnClaimSetRequest' + required: true + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '404': + description: Not found. A resource with given identifier could not be found. + '400': + description: Bad Request. The request was invalid and cannot be completed. See the response body for details. + '200': + description: OK + '/v2/claimSets/{claimSetId}/resourceClaimActions/{resourceClaimId}/resetAuthorizationStrategies': + post: + tags: + - ClaimSets + summary: Resets to default authorization strategies on provided resource claim. + parameters: + - name: claimSetId + in: path + required: true + schema: + type: integer + format: int32 + - name: resourceClaimId + in: path + required: true + schema: + type: integer + format: int32 + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '404': + description: Not found. A resource with given identifier could not be found. + '400': + description: Bad Request. The request was invalid and cannot be completed. See the response body for details. + '200': + description: OK + '/v2/claimSets/{claimSetId}/resourceClaimActions': + post: + tags: + - ClaimSets + summary: Adds ResourceClaimAction association to a claim set. + description: "Add resourceClaimAction association to claim set. At least one action should be enabled. Valid actions are read, create, update, delete, readchanges.\r\nresouceclaimId is required fields." + parameters: + - name: claimSetId + in: path + required: true + schema: + type: integer + format: int32 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/addResourceClaimOnClaimSetRequest' + required: true + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '404': + description: Not found. A resource with given identifier could not be found. + '400': + description: Bad Request. The request was invalid and cannot be completed. See the response body for details. + '201': + description: Created + /connect/register: + post: + tags: + - Connect + summary: Registers new client + description: Registers new client + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + properties: + ClientId: + type: string + description: Client id + ClientSecret: + type: string + description: Client secret + DisplayName: + type: string + description: Client display name + encoding: + ClientId: + style: form + ClientSecret: + style: form + DisplayName: + style: form + responses: + '400': + description: Bad Request. The request was invalid and cannot be completed. See the response body for details. + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '200': + description: Application registered successfully. + /connect/token: + post: + tags: + - Connect + summary: Retrieves bearer token + description: "\nTo authenticate Swagger requests, execute using \"Authorize\" above, not \"Try It Out\" here." + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + properties: + client_id: + type: 'string ' + client_secret: + type: 'string ' + grant_type: + type: 'string ' + scope: + type: string + responses: + '400': + description: Bad Request. The request was invalid and cannot be completed. See the response body for details. + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '200': + description: Sign-in successful. + '/v2/claimSets/{claimSetId}/resourceClaimActions/{resourceClaimId}': + put: + tags: + - ClaimSets + summary: Updates the ResourceClaimActions to a specific resource claim on a claimset. + description: 'Updates the resourceClaimActions to a specific resource claim on a claimset. At least one action should be enabled. Valid actions are read, create, update, delete, readchanges.' + parameters: + - name: claimSetId + in: path + required: true + schema: + type: integer + format: int32 + - name: resourceClaimId + in: path + required: true + schema: + type: integer + format: int32 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/editResourceClaimOnClaimSetRequest' + required: true + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '404': + description: Not found. A resource with given identifier could not be found. + '400': + description: Bad Request. The request was invalid and cannot be completed. See the response body for details. + '200': + description: OK + delete: + tags: + - ClaimSets + summary: Deletes a resource claims association from a claimset + parameters: + - name: claimSetId + in: path + required: true + schema: + type: integer + format: int32 + - name: resourceClaimId + in: path + required: true + schema: + type: integer + format: int32 + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '404': + description: Not found. A resource with given identifier could not be found. + '200': + description: OK + '/v2/applications/{id}/reset-credential': + put: + tags: + - Applications + summary: Reset application credentials. Returns new key and secret. + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int32 + responses: + '401': + description: Unauthorized. The request requires authentication + '403': + description: 'Forbidden. The request is authenticated, but not authorized to access this resource' + '409': + description: 'Conflict. The request is authenticated, but it has a conflict with an existing element' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '404': + description: Not found. A resource with given identifier could not be found. + '400': + description: Bad Request. The request was invalid and cannot be completed. See the response body for details. + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/applicationResult' +components: + schemas: + actionModel: + title: Action + type: object + properties: + id: + type: integer + format: int32 + name: + type: string + nullable: true + uri: + type: string + nullable: true + additionalProperties: false + addApplicationRequest: + title: AddApplicationRequest + type: object + properties: + applicationName: + type: string + description: Application name + vendorId: + type: integer + description: Vendor/ company id + format: int32 + claimSetName: + type: string + description: Claim set name + profileIds: + type: array + items: + type: integer + format: int32 + description: Profile id + nullable: true + educationOrganizationIds: + type: array + items: + type: integer + format: int64 + description: Education organization ids + odsInstanceIds: + type: array + items: + type: integer + format: int32 + description: List of ODS instance id + additionalProperties: false + addClaimSetRequest: + title: AddClaimSetRequest + type: object + properties: + name: + type: string + description: Claim set name + additionalProperties: false + addOdsInstanceContextRequest: + title: AddOdsInstanceContextRequest + type: object + properties: + odsInstanceId: + type: integer + description: ODS instance context ODS instance id. + format: int32 + contextKey: + type: string + description: context key. + contextValue: + type: string + description: context value. + additionalProperties: false + addOdsInstanceDerivativeRequest: + title: AddOdsInstanceDerivativeRequest + type: object + properties: + odsInstanceId: + type: integer + description: ODS instance derivative ODS instance id. + format: int32 + derivativeType: + type: string + description: derivative type. + connectionString: + type: string + description: connection string. + additionalProperties: false + addOdsInstanceRequest: + title: AddOdsInstanceRequest + type: object + properties: + name: + type: string + description: Ods Instance name + instanceType: + type: string + description: Ods Instance type + nullable: true + connectionString: + type: string + description: Ods Instance connection string + additionalProperties: false + addProfileRequest: + title: AddProfileRequest + type: object + properties: + name: + type: string + description: Profile name + definition: + type: string + description: Profile definition + additionalProperties: false + example: "{\n \"name\": \"Test-Profile\",\n \"definition\": \"\"\n}" + addResourceClaimOnClaimSetRequest: + title: AddResourceClaimActionsOnClaimSetRequest + type: object + properties: + resourceClaimId: + type: integer + description: ResourceClaim id + format: int32 + resourceClaimActions: + type: array + items: + $ref: '#/components/schemas/resourceClaimAction' + additionalProperties: false + addVendorRequest: + title: AddVendorRequest + type: object + properties: + company: + type: string + description: Vendor/ company name + namespacePrefixes: + type: string + description: Namespace prefix for the vendor. Multiple namespace prefixes can be provided as comma separated list if required. + contactName: + type: string + description: Vendor contact name + contactEmailAddress: + type: string + description: Vendor contact email id + additionalProperties: false + adminApiError: + title: AdminApiError + type: object + properties: + title: + type: string + nullable: true + readOnly: true + errors: + type: array + items: + type: string + nullable: true + readOnly: true + additionalProperties: false + description: Wrapper schema for all error responses + applicationModel: + title: Application + type: object + properties: + id: + type: integer + format: int32 + applicationName: + type: string + nullable: true + claimSetName: + type: string + nullable: true + educationOrganizationIds: + type: array + items: + type: integer + format: int64 + nullable: true + vendorId: + type: integer + format: int32 + nullable: true + profileIds: + type: array + items: + type: integer + format: int32 + nullable: true + odsInstanceIds: + type: array + items: + type: integer + format: int32 + nullable: true + additionalProperties: false + applicationResult: + title: ApplicationKeySecret + type: object + properties: + id: + type: integer + format: int32 + key: + type: string + nullable: true + secret: + type: string + nullable: true + additionalProperties: false + authorizationStrategy: + title: ResourceClaimAuthorizationStrategy + type: object + properties: + authStrategyId: + type: integer + format: int32 + authStrategyName: + type: string + nullable: true + isInheritedFromParent: + type: boolean + additionalProperties: false + authorizationStrategyModel: + title: AuthorizationStrategy + type: object + properties: + id: + type: integer + format: int32 + name: + type: string + nullable: true + displayName: + type: string + nullable: true + additionalProperties: false + claimSetDetailsModel: + title: ClaimSetWithResources + type: object + properties: + id: + type: integer + format: int32 + name: + type: string + nullable: true + _isSystemReserved: + type: boolean + readOnly: true + _applications: + type: array + items: + $ref: '#/components/schemas/simpleApplicationModel' + nullable: true + readOnly: true + resourceClaims: + type: array + items: + $ref: '#/components/schemas/claimSetResourceClaimModel' + nullable: true + additionalProperties: false + claimSetModel: + title: ClaimSet + type: object + properties: + id: + type: integer + format: int32 + name: + type: string + nullable: true + _isSystemReserved: + type: boolean + readOnly: true + _applications: + type: array + items: + $ref: '#/components/schemas/simpleApplicationModel' + nullable: true + readOnly: true + additionalProperties: false + claimSetResourceClaimActionAuthStrategies: + title: ClaimSetResourceClaimActionAuthorizationStrategies + type: object + properties: + actionId: + type: integer + format: int32 + nullable: true + actionName: + type: string + nullable: true + authorizationStrategies: + type: array + items: + $ref: '#/components/schemas/authorizationStrategy' + nullable: true + additionalProperties: false + claimSetResourceClaimModel: + title: ClaimSetResourceClaim + type: object + properties: + id: + type: integer + format: int32 + readOnly: true + name: + type: string + nullable: true + actions: + type: array + items: + $ref: '#/components/schemas/resourceClaimAction' + nullable: true + _defaultAuthorizationStrategiesForCRUD: + type: array + items: + $ref: '#/components/schemas/claimSetResourceClaimActionAuthStrategies' + nullable: true + readOnly: true + authorizationStrategyOverridesForCRUD: + type: array + items: + $ref: '#/components/schemas/claimSetResourceClaimActionAuthStrategies' + nullable: true + children: + type: array + items: + $ref: '#/components/schemas/claimSetResourceClaimModel' + description: Children are collection of ResourceClaim + nullable: true + additionalProperties: false + copyClaimSetRequest: + title: CopyClaimSetRequest + type: object + properties: + originalId: + type: integer + description: ClaimSet id to copy + format: int32 + name: + type: string + description: New claimset name + additionalProperties: false + editApplicationRequest: + title: EditApplicationRequest + type: object + properties: + applicationName: + type: string + description: Application name + vendorId: + type: integer + description: Vendor/ company id + format: int32 + claimSetName: + type: string + description: Claim set name + profileIds: + type: array + items: + type: integer + format: int32 + description: Profile id + nullable: true + educationOrganizationIds: + type: array + items: + type: integer + format: int64 + description: Education organization ids + odsInstanceIds: + type: array + items: + type: integer + format: int32 + description: List of ODS instance id + additionalProperties: false + editClaimSetRequest: + title: EditClaimSetRequest + type: object + properties: + name: + type: string + description: Claim set name + additionalProperties: false + editOdsInstanceContextRequest: + title: EditOdsInstanceContextRequest + type: object + properties: + odsInstanceId: + type: integer + description: ODS instance context ODS instance id. + format: int32 + contextKey: + type: string + description: context key. + contextValue: + type: string + description: context value. + additionalProperties: false + editOdsInstanceDerivativeRequest: + title: EditOdsInstanceDerivativeRequest + type: object + properties: + odsInstanceId: + type: integer + description: ODS instance derivative ODS instance id. + format: int32 + derivativeType: + type: string + description: derivative type. + connectionString: + type: string + description: connection string. + additionalProperties: false + editOdsInstanceRequest: + title: EditOdsInstanceRequest + type: object + properties: + name: + type: string + description: Ods Instance name + instanceType: + type: string + description: Ods Instance type + nullable: true + connectionString: + type: string + description: Ods Instance connection string + nullable: true + additionalProperties: false + editProfileRequest: + title: EditProfileRequest + type: object + properties: + name: + type: string + description: Profile name + definition: + type: string + description: Profile definition + additionalProperties: false + example: "{\n \"name\": \"Test-Profile\",\n \"definition\": \"\"\n}" + editResourceClaimOnClaimSetRequest: + title: EditResourceClaimActionsOnClaimSetRequest + type: object + properties: + resourceClaimActions: + type: array + items: + $ref: '#/components/schemas/resourceClaimAction' + additionalProperties: false + editVendorRequest: + title: EditVendorRequest + type: object + properties: + company: + type: string + description: Vendor/ company name + namespacePrefixes: + type: string + description: Namespace prefix for the vendor. Multiple namespace prefixes can be provided as comma separated list if required. + contactName: + type: string + description: Vendor contact name + contactEmailAddress: + type: string + description: Vendor contact email id + additionalProperties: false + importClaimSetRequest: + title: ImportClaimSetRequest + type: object + properties: + name: + type: string + description: Claim set name + resourceClaims: + type: array + items: + $ref: '#/components/schemas/claimSetResourceClaimModel' + description: Resource Claims + additionalProperties: false + informationResult: + title: Information + type: object + properties: + version: + type: string + description: Application version + build: + type: string + description: Build / release version + additionalProperties: false + odsInstanceContextModel: + title: OdsInstanceContext + type: object + properties: + id: + type: integer + format: int32 + odsInstanceId: + type: integer + format: int32 + contextKey: + type: string + nullable: true + contextValue: + type: string + nullable: true + additionalProperties: false + odsInstanceDerivativeModel: + title: OdsInstanceDerivative + type: object + properties: + id: + type: integer + format: int32 + odsInstanceId: + type: integer + format: int32 + nullable: true + derivativeType: + type: string + nullable: true + additionalProperties: false + odsInstanceDetailModel: + title: OdsInstanceDetail + type: object + properties: + id: + type: integer + format: int32 + name: + type: string + nullable: true + instanceType: + type: string + nullable: true + odsInstanceContexts: + type: array + items: + $ref: '#/components/schemas/odsInstanceContextModel' + nullable: true + odsInstanceDerivatives: + type: array + items: + $ref: '#/components/schemas/odsInstanceDerivativeModel' + nullable: true + additionalProperties: false + odsInstanceModel: + title: OdsInstance + type: object + properties: + id: + type: integer + format: int32 + name: + type: string + nullable: true + instanceType: + type: string + nullable: true + additionalProperties: false + overrideAuthStategyOnClaimSetRequest: + title: OverrideAuthStategyOnClaimSetRequest + type: object + properties: + actionName: + type: string + nullable: true + authorizationStrategies: + type: array + items: + type: string + description: AuthorizationStrategy Names + additionalProperties: false + profileDetailsModel: + title: ProfileDetails + type: object + properties: + id: + type: integer + format: int32 + nullable: true + name: + type: string + nullable: true + definition: + type: string + nullable: true + additionalProperties: false + profileModel: + title: Profile + type: object + properties: + id: + type: integer + format: int32 + nullable: true + name: + type: string + nullable: true + additionalProperties: false + registerClientRequest: + title: RegisterClientRequest + type: object + properties: + clientId: + type: string + description: Client id + clientSecret: + type: string + description: Client secret + displayName: + type: string + description: Client display name + additionalProperties: false + resourceClaimAction: + title: ResourceClaimAction + type: object + properties: + name: + type: string + nullable: true + enabled: + type: boolean + additionalProperties: false + resourceClaimModel: + title: ResourceClaimModel + type: object + properties: + id: + type: integer + format: int32 + name: + type: string + nullable: true + parentId: + type: integer + format: int32 + nullable: true + parentName: + type: string + nullable: true + children: + type: array + items: + $ref: '#/components/schemas/resourceClaimModel' + description: Children are collection of SimpleResourceClaimModel + nullable: true + additionalProperties: false + simpleApplicationModel: + title: Application + type: object + properties: + applicationName: + type: string + nullable: true + additionalProperties: false + vendorModel: + title: Vendor + type: object + properties: + id: + type: integer + format: int32 + nullable: true + company: + type: string + nullable: true + namespacePrefixes: + type: string + nullable: true + contactName: + type: string + nullable: true + contactEmailAddress: + type: string + nullable: true + additionalProperties: false + securitySchemes: + oauth: + type: oauth2 + flows: + clientCredentials: + tokenUrl: https://localhost/connect/token + scopes: + edfi_admin_api/full_access: Unrestricted access to all Admin API endpoints +security: + - oauth: + - api \ No newline at end of file From 74eae9a03e289151a2362c0e9b9352d91cb5958f Mon Sep 17 00:00:00 2001 From: Juan Agudelo Date: Tue, 26 Nov 2024 11:33:28 -0500 Subject: [PATCH 2/5] Add the adminconsole version to generate the definition in the build.ps1 --- build.ps1 | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/build.ps1 b/build.ps1 index e41986e55..8c98f0659 100644 --- a/build.ps1 +++ b/build.ps1 @@ -189,6 +189,16 @@ function GenerateOpenAPI { } } +function GenerateOpenAPIAdminConsole { + Invoke-Execute { + cd $solutionRoot/EdFi.Ods.AdminApi/ + $outputOpenAPI = "../../docs/api-specifications/openapi-yaml/admin-api-console-$APIVersion.yaml" + $dllPath = "./bin/Release/net8.0/EdFi.Ods.AdminApi.dll" + dotnet tool run swagger tofile --output $outputOpenAPI --yaml $dllPath adminconsole + cd ..\.. + } +} + function GenerateDocumentation { Invoke-Execute { $outputOpenAPI = "docs/api-specifications/openapi-yaml/admin-api-$APIVersion.yaml" @@ -197,6 +207,14 @@ function GenerateDocumentation { } } +function GenerateDocumentationAdminConsole { + Invoke-Execute { + $outputOpenAPI = "docs/api-specifications/openapi-yaml/admin-api-console-$APIVersion.yaml" + $outputMD = "docs/api-specifications/markdown/admin-api-console-$APIVersion-summary.md" + widdershins --search false --omitHeader true --code true --summary $outputOpenAPI -o $outputMD + } +} + function PublishAdminApi { Invoke-Execute { $project = "$solutionRoot/EdFi.Ods.AdminApi/" @@ -331,7 +349,9 @@ function Invoke-GenerateOpenAPIAndMD { Invoke-Step { Restore } Invoke-Step { Compile } Invoke-Step { GenerateOpenAPI } + Invoke-Step { GenerateOpenAPIAdminConsole } Invoke-Step { GenerateDocumentation } + Invoke-Step { GenerateDocumentationAdminConsole } } function Invoke-SetAssemblyInfo { From d6e9a6856d57320f967336309b693ddc478af952 Mon Sep 17 00:00:00 2001 From: Juan Agudelo Date: Tue, 26 Nov 2024 11:36:35 -0500 Subject: [PATCH 3/5] Update and add the openapi definition for adminapi and adminconsole endpoints --- .../markdown/admin-api-2.3.0-summary.md | 8 +- .../admin-api-console-2.3.0-summary.md | 205 ++++++++++++++++++ .../openapi-yaml/admin-api-2.3.0.yaml | 4 +- .../openapi-yaml/admin-api-console-2.3.0.yaml | 140 ++++++++++++ 4 files changed, 351 insertions(+), 6 deletions(-) create mode 100644 docs/api-specifications/markdown/admin-api-console-2.3.0-summary.md create mode 100644 docs/api-specifications/openapi-yaml/admin-api-console-2.3.0.yaml diff --git a/docs/api-specifications/markdown/admin-api-2.3.0-summary.md b/docs/api-specifications/markdown/admin-api-2.3.0-summary.md index c0733063e..c4bfb4101 100644 --- a/docs/api-specifications/markdown/admin-api-2.3.0-summary.md +++ b/docs/api-specifications/markdown/admin-api-2.3.0-summary.md @@ -506,7 +506,7 @@ The POST operation can be used to create or update resources. In database terms, > Body parameter ```json -"{\n \"name\": \"Test-Profile\",\n \"definition\": \"\"\n}" +"{\r\n \"name\": \"Test-Profile\",\r\n \"definition\": \"\"\r\n}" ```

Parameters

@@ -580,7 +580,7 @@ The PUT operation is used to update a resource by identifier. If the resource id > Body parameter ```json -"{\n \"name\": \"Test-Profile\",\n \"definition\": \"\"\n}" +"{\r\n \"name\": \"Test-Profile\",\r\n \"definition\": \"\"\r\n}" ```

Parameters

@@ -2706,7 +2706,7 @@ AddOdsInstanceRequest ```json -"{\n \"name\": \"Test-Profile\",\n \"definition\": \"\"\n}" +"{\r\n \"name\": \"Test-Profile\",\r\n \"definition\": \"\"\r\n}" ``` @@ -3327,7 +3327,7 @@ EditOdsInstanceRequest ```json -"{\n \"name\": \"Test-Profile\",\n \"definition\": \"\"\n}" +"{\r\n \"name\": \"Test-Profile\",\r\n \"definition\": \"\"\r\n}" ``` diff --git a/docs/api-specifications/markdown/admin-api-console-2.3.0-summary.md b/docs/api-specifications/markdown/admin-api-console-2.3.0-summary.md new file mode 100644 index 000000000..9ade5b1c8 --- /dev/null +++ b/docs/api-specifications/markdown/admin-api-console-2.3.0-summary.md @@ -0,0 +1,205 @@ + + +

Admin API Documentation vadminconsole

+ +> Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu. + +The Ed-Fi Admin API is a REST API-based administrative interface for managing vendors, applications, client credentials, and authorization rules for accessing an Ed-Fi API. + +# Authentication + +- oAuth2 authentication. + + - Flow: clientCredentials + + - Token URL = [https://localhost/connect/token](https://localhost/connect/token) + +|Scope|Scope Description| +|---|---| +|edfi_admin_api/full_access|Unrestricted access to all Admin API endpoints| + +

Information

+ +## Retrieve API informational metadata + +`GET /` + +> Example responses + +> 200 Response + +```json +{ + "version": "string", + "build": "string" +} +``` + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[informationResult](#schemainformationresult)| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|[informationResult](#schemainformationresult)| + + + +

Connect

+ +## Registers new client + +`POST /connect/register` + +Registers new client + +> Body parameter + +```yaml +ClientId: string +ClientSecret: string +DisplayName: string + +``` + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|body|body|object|false|none| +|» ClientId|body|string|false|Client id| +|» ClientSecret|body|string|false|Client secret| +|» DisplayName|body|string|false|Client display name| + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Application registered successfully.|None| +|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request. The request was invalid and cannot be completed. See the response body for details.|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + + + +## Retrieves bearer token + +`POST /connect/token` + +To authenticate Swagger requests, execute using "Authorize" above, not "Try It Out" here. + +> Body parameter + +```yaml +client_id: null +client_secret: null +grant_type: null +scope: string + +``` + +

Parameters

+ +|Name|In|Type|Required|Description| +|---|---|---|---|---| +|body|body|object|false|none| +|» client_id|body|string |false|none| +|» client_secret|body|string |false|none| +|» grant_type|body|string |false|none| +|» scope|body|string|false|none| + +

Responses

+ +|Status|Meaning|Description|Schema| +|---|---|---|---| +|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Sign-in successful.|None| +|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request. The request was invalid and cannot be completed. See the response body for details.|None| +|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Internal server error. An unhandled error occurred on the server. See the response body for details.|None| + + + +# Schemas + +

adminApiError

+ + + + + + +```json +{ + "title": "string", + "errors": [ + "string" + ] +} + +``` + +AdminApiError + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|title|string¦null|false|read-only|none| +|errors|[string]¦null|false|read-only|none| + +

informationResult

+ + + + + + +```json +{ + "version": "string", + "build": "string" +} + +``` + +Information + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|version|string|false|none|Application version| +|build|string|false|none|Build / release version| + +

registerClientRequest

+ + + + + + +```json +{ + "clientId": "string", + "clientSecret": "string", + "displayName": "string" +} + +``` + +RegisterClientRequest + +### Properties + +|Name|Type|Required|Restrictions|Description| +|---|---|---|---|---| +|clientId|string|false|none|Client id| +|clientSecret|string|false|none|Client secret| +|displayName|string|false|none|Client display name| + diff --git a/docs/api-specifications/openapi-yaml/admin-api-2.3.0.yaml b/docs/api-specifications/openapi-yaml/admin-api-2.3.0.yaml index d802bdb11..de86b14ab 100644 --- a/docs/api-specifications/openapi-yaml/admin-api-2.3.0.yaml +++ b/docs/api-specifications/openapi-yaml/admin-api-2.3.0.yaml @@ -2004,7 +2004,7 @@ components: type: string description: Profile definition additionalProperties: false - example: "{\n \"name\": \"Test-Profile\",\n \"definition\": \"\"\n}" + example: "{\r\n \"name\": \"Test-Profile\",\r\n \"definition\": \"\"\r\n}" addResourceClaimOnClaimSetRequest: title: AddResourceClaimActionsOnClaimSetRequest type: object @@ -2335,7 +2335,7 @@ components: type: string description: Profile definition additionalProperties: false - example: "{\n \"name\": \"Test-Profile\",\n \"definition\": \"\"\n}" + example: "{\r\n \"name\": \"Test-Profile\",\r\n \"definition\": \"\"\r\n}" editResourceClaimOnClaimSetRequest: title: EditResourceClaimActionsOnClaimSetRequest type: object diff --git a/docs/api-specifications/openapi-yaml/admin-api-console-2.3.0.yaml b/docs/api-specifications/openapi-yaml/admin-api-console-2.3.0.yaml new file mode 100644 index 000000000..cec608e7a --- /dev/null +++ b/docs/api-specifications/openapi-yaml/admin-api-console-2.3.0.yaml @@ -0,0 +1,140 @@ +openapi: 3.0.1 +info: + title: Admin API Documentation + description: 'The Ed-Fi Admin API is a REST API-based administrative interface for managing vendors, applications, client credentials, and authorization rules for accessing an Ed-Fi API.' + version: adminconsole +paths: + /: + get: + tags: + - Information + summary: Retrieve API informational metadata + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/informationResult' + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + content: + application/json: + schema: + $ref: '#/components/schemas/informationResult' + /connect/register: + post: + tags: + - Connect + summary: Registers new client + description: Registers new client + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + properties: + ClientId: + type: string + description: Client id + ClientSecret: + type: string + description: Client secret + DisplayName: + type: string + description: Client display name + encoding: + ClientId: + style: form + ClientSecret: + style: form + DisplayName: + style: form + responses: + '400': + description: Bad Request. The request was invalid and cannot be completed. See the response body for details. + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '200': + description: Application registered successfully. + /connect/token: + post: + tags: + - Connect + summary: Retrieves bearer token + description: "\nTo authenticate Swagger requests, execute using \"Authorize\" above, not \"Try It Out\" here." + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + properties: + client_id: + type: 'string ' + client_secret: + type: 'string ' + grant_type: + type: 'string ' + scope: + type: string + responses: + '400': + description: Bad Request. The request was invalid and cannot be completed. See the response body for details. + '500': + description: Internal server error. An unhandled error occurred on the server. See the response body for details. + '200': + description: Sign-in successful. +components: + schemas: + adminApiError: + title: AdminApiError + type: object + properties: + title: + type: string + nullable: true + readOnly: true + errors: + type: array + items: + type: string + nullable: true + readOnly: true + additionalProperties: false + description: Wrapper schema for all error responses + informationResult: + title: Information + type: object + properties: + version: + type: string + description: Application version + build: + type: string + description: Build / release version + additionalProperties: false + registerClientRequest: + title: RegisterClientRequest + type: object + properties: + clientId: + type: string + description: Client id + clientSecret: + type: string + description: Client secret + displayName: + type: string + description: Client display name + additionalProperties: false + securitySchemes: + oauth: + type: oauth2 + flows: + clientCredentials: + tokenUrl: https://localhost/connect/token + scopes: + edfi_admin_api/full_access: Unrestricted access to all Admin API endpoints +security: + - oauth: + - api \ No newline at end of file From f171566cc4dd3a658988996d58b1e6104cf11853 Mon Sep 17 00:00:00 2001 From: Juan Agudelo Date: Tue, 26 Nov 2024 11:41:46 -0500 Subject: [PATCH 4/5] Rename files to add '-pre' --- ...{admin-api-2.3.0-summary.md => admin-api-2.3.0-summary-pre.md} | 0 ...le-2.3.0-summary.md => admin-api-console-2.3.0-summary-pre.md} | 0 .../{admin-api-2.3.0.yaml => admin-api-2.3.0-pre.yaml} | 0 ...in-api-console-2.3.0.yaml => admin-api-console-2.3.0-pre.yaml} | 0 4 files changed, 0 insertions(+), 0 deletions(-) rename docs/api-specifications/markdown/{admin-api-2.3.0-summary.md => admin-api-2.3.0-summary-pre.md} (100%) rename docs/api-specifications/markdown/{admin-api-console-2.3.0-summary.md => admin-api-console-2.3.0-summary-pre.md} (100%) rename docs/api-specifications/openapi-yaml/{admin-api-2.3.0.yaml => admin-api-2.3.0-pre.yaml} (100%) rename docs/api-specifications/openapi-yaml/{admin-api-console-2.3.0.yaml => admin-api-console-2.3.0-pre.yaml} (100%) diff --git a/docs/api-specifications/markdown/admin-api-2.3.0-summary.md b/docs/api-specifications/markdown/admin-api-2.3.0-summary-pre.md similarity index 100% rename from docs/api-specifications/markdown/admin-api-2.3.0-summary.md rename to docs/api-specifications/markdown/admin-api-2.3.0-summary-pre.md diff --git a/docs/api-specifications/markdown/admin-api-console-2.3.0-summary.md b/docs/api-specifications/markdown/admin-api-console-2.3.0-summary-pre.md similarity index 100% rename from docs/api-specifications/markdown/admin-api-console-2.3.0-summary.md rename to docs/api-specifications/markdown/admin-api-console-2.3.0-summary-pre.md diff --git a/docs/api-specifications/openapi-yaml/admin-api-2.3.0.yaml b/docs/api-specifications/openapi-yaml/admin-api-2.3.0-pre.yaml similarity index 100% rename from docs/api-specifications/openapi-yaml/admin-api-2.3.0.yaml rename to docs/api-specifications/openapi-yaml/admin-api-2.3.0-pre.yaml diff --git a/docs/api-specifications/openapi-yaml/admin-api-console-2.3.0.yaml b/docs/api-specifications/openapi-yaml/admin-api-console-2.3.0-pre.yaml similarity index 100% rename from docs/api-specifications/openapi-yaml/admin-api-console-2.3.0.yaml rename to docs/api-specifications/openapi-yaml/admin-api-console-2.3.0-pre.yaml From 0d83e30270af1eb5e77c7aa3b6e6b76b12e52e30 Mon Sep 17 00:00:00 2001 From: Juan Agudelo Date: Tue, 26 Nov 2024 11:46:24 -0500 Subject: [PATCH 5/5] Disable to push new docker image to the repository when a PR is issued --- .github/workflows/on-pullrequest-dockerfile-ac.yml | 3 --- 1 file changed, 3 deletions(-) diff --git a/.github/workflows/on-pullrequest-dockerfile-ac.yml b/.github/workflows/on-pullrequest-dockerfile-ac.yml index 844dacfd9..f747a6a45 100644 --- a/.github/workflows/on-pullrequest-dockerfile-ac.yml +++ b/.github/workflows/on-pullrequest-dockerfile-ac.yml @@ -9,9 +9,6 @@ push: branches: - adminapi23-rc.* - pull_request: - branches: - - adminapi23-rc.* workflow_dispatch: env: