GridViews

Quick Reference

Method

Endpoint

Description

GET

/api/views/all

GET

/api/views/{viewId}

DELETE

/api/views/{viewId}

GET

/api/views/{viewId}/accessinfo

POST

/api/views

PUT

/api/views/{viewId}/access

GET

/api/views/datasetsps

GET

/api/views/datasetsp/{spName}

GET /api/views/all

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/views/all"

)

# Process the response
print(response)

Sample Response:

1{
2  "status": "success",
3  "data": {}
4}

GET /api/views/{viewId}

Parameters:

Path Parameters:

  • viewId (integer, path) (required): No description available

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/views/{viewId}"
,
    viewId=789e0123-e89b-12d3-a456-426614174002

)

# Process the response
print(response)

Sample Response:

1{
2  "status": "success",
3  "data": {}
4}

DELETE /api/views/{viewId}

Parameters:

Path Parameters:

  • viewId (integer, path) (required): No description available

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.delete(
    "/api/views/{viewId}"
,
    viewId=789e0123-e89b-12d3-a456-426614174002

)

# Process the response
print(response)

Sample Response:

1{
2  "status": "success",
3  "message": "Resource deleted successfully"
4}

GET /api/views/{viewId}/accessinfo

Parameters:

Path Parameters:

  • viewId (integer, path) (required): No description available

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/views/{viewId}/accessinfo"
,
    viewId=789e0123-e89b-12d3-a456-426614174002

)

# Process the response
print(response)

Sample Response:

1{
2  "status": "success",
3  "data": {}
4}

POST /api/views

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.post(
    "/api/views"
,
    data=
    {
        "example": "data"
}

)

# Process the response
print(response)

Sample Response:

1{
2  "id": "789e0123-e89b-12d3-a456-426614174002",
3  "status": "created",
4  "message": "Resource created successfully"
5}

PUT /api/views/{viewId}/access

Parameters:

Path Parameters:

  • viewId (integer, path) (required): No description available

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.put(
    "/api/views/{viewId}/access"
,
    viewId=789e0123-e89b-12d3-a456-426614174002
,
    data=
    {
        "example": "data"
}

)

# Process the response
print(response)

Sample Response:

1{
2  "id": "123e4567-e89b-12d3-a456-426614174000",
3  "status": "updated",
4  "message": "Resource updated successfully"
5}

GET /api/views/datasetsps

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/views/datasetsps"

)

# Process the response
print(response)

Sample Response:

1[]

GET /api/views/datasetsp/{spName}

Parameters:

Path Parameters:

  • spName (string, path) (required): No description available

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/views/datasetsp/{spName}"
,
    spName="Example Name"

)

# Process the response
print(response)

Sample Response:

1{
2  "status": "success",
3  "data": {}
4}