Organization API Data Model Access Report

Endpoint

GET /apiops/reports/organization-api-data-model-access

Authentication

Requires a Personal API Access Token.

Header

Authorization: Bearer YOUR_TOKEN

Request

Headers

Header	Value	Required
Authorization	Bearer {token}	Yes

Path Parameters

None.

Query Parameters

None. The backend applies a fixed filter: sharing types EXTERNAL and BOTH only.

Response

Success Response (200 OK)

{
  "status": "SUCCESS",
  "result": {
    "apiAccessList": [
      {
        "id": "api-proxy-id",
        "name": "MyAPI",
        "description": "External API",
        "sharingType": "EXTERNAL",
        "routingUrl": "https://api.example.com/my-api",
        "projectId": "project-id",
        "projectName": "MyProject",
        "methodList": [
          {
            "id": "method-id",
            "name": "GET /users",
            "description": "List users",
            "dataModelId": "model-id",
            "dataModelName": "UserModel",
            "dataModelDescription": "User payload schema",
            "credentialList": [
              {
                "id": "credential-id",
                "username": "client-app",
                "email": "app@example.com",
                "description": "Portal credential",
                "organization": {
                  "id": "org-id",
                  "name": "Example Org"
                }
              }
            ]
          }
        ]
      }
    ],
    "schemaMap": {
      "UserModel": {
        "modelName": "UserModel",
        "name": "User",
        "type": "object"
      }
    }
  }
}

Response Fields

Field	Type	Description
status	string	"SUCCESS" when the request completes successfully
result	object	Report wrapper. See Report Result Object

Report Result Object (result)

Field	Type	Description
apiAccessList	array[object]	API Proxy access rows with methods and credentials
schemaMap	object	Map of data model name → OpenAPI-style schema DTO (SpecSchemaDTO)

API Access Object (apiAccessList item)

Field	Type	Description
id	string	API Proxy ID
name	string	API Proxy name
description	string	API Proxy description
sharingType	string	Sharing type. See EnumSharingType
routingUrl	string	Routing / access URL
projectId	string	Project ID
projectName	string	Project name
methodList	array[object]	Methods with data model and credential access details

Method Object (methodList item)

Field	Type	Description
id	string	Method ID
name	string	Method name / label
description	string	Method description
dataModelId	string	Linked data model ID
dataModelName	string	Data model name
dataModelDescription	string	Data model description
uvsRequestDataElementUuid	string	UVS request data element UUID (when configured)
uvsResponseDataElementUuid	string	UVS response data element UUID (when configured)
credentialList	array[object]	Credentials (and organizations) with access

Credential Object (credentialList item)

Field	Type	Description
id	string	Credential ID
username	string	Credential username
email	string	Credential email
description	string	Credential description
organization	object	Organization reference (id, name, …)

EnumSharingType (sharingType)

• EXTERNAL - Shared externally
• INTERNAL - Shared internally only
• BOTH - Shared both internally and externally
• NONE - Not shared

Notes

• Backend query includes only APIs with EXTERNAL or BOTH sharing types
• schemaMap keys are data model names; values follow SpecSchemaDTO (OpenAPI schema subset)
• Empty apiAccessList or empty schemaMap may be returned when no data matches

Error Response (401 Unauthorized)

Invalid or missing API token:

{
  "status": "FAILURE",
  "resultMessage": "User not found!"
}

cURL Example

curl -X GET \
  "https://demo.apinizer.com/apiops/reports/organization-api-data-model-access" \
  -H "Authorization: Bearer YOUR_TOKEN"

Permissions

Backend requires a valid API token only; it does not check sysAdmin / sysAnalyzer in the current implementation. See Reports API for the privilege difference vs API Report.

Notes and Warnings

• Sharing filter (backend-fixed):

  • Only EXTERNAL and BOTH APIs are included
  • Internal-only APIs are excluded

• Privilege mismatch vs API Report:

  • API Report enforces sysAdmin / sysAnalyzer
  • This endpoint does not — document and secure accordingly in integrations

• Read-only:

  • No request body; no side effects

Related Documentation

• API Report - API Proxy inventory report
• Update Metadata - Update API Proxy sharing type