-
Api Collection
- Create My Api Collection
- Create My Api Collection Endpoint
- Create My Api Collection Endpoint By Id
- Delete My Api Collection
- Delete My Api Collection Endpoint
- Delete My Api Collection Endpoint By Id
- Delete My Api Collection Endpoint By Id
- Get All API Collections
- Get Api Collection Endpoints
- Get Api Collections for User
- Get Featured Api Collections
- Get My Api Collection By Id
- Get My Api Collection By Name
- Get My Api Collection Endpoint
- Get My Api Collection Endpoints
- Get My Api Collection Endpoints By Id
- Get My Api Collections
- Get Sharable Api Collection By Id
- Update My Api Collection By API_COLLECTION_ID
-
Api Collection
- Create My Api Collection
- Create My Api Collection Endpoint
- Create My Api Collection Endpoint By Id
- Delete My Api Collection
- Delete My Api Collection Endpoint
- Delete My Api Collection Endpoint By Id
- Delete My Api Collection Endpoint By Id
- Get All API Collections
- Get Api Collection Endpoints
- Get Api Collections for User
- Get Featured Api Collections
- Get My Api Collection By Id
- Get My Api Collection By Name
- Get My Api Collection Endpoint
- Get My Api Collection Endpoints
- Get My Api Collection Endpoints By Id
- Get My Api Collections
- Get Sharable Api Collection By Id
- Update My Api Collection By API_COLLECTION_ID
v5.1.0 filtered by tag: Api-Collection (19 APIs)
Create My Api Collection
Create Api Collection for logged in user.
Authentication is Mandatory
JSON request body fields:
api_collection_name: Favourites
is_sharable: is_sharable
description: This an optional field. Maximum length is 2000. It can be any characters here.
JSON response body fields:
api_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
api_collection_name: Favourites
description: This an optional field. Maximum length is 2000. It can be any characters here.
is_sharable: is_sharable
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
{
"api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"api_collection_name":"Favourites",
"is_sharable":true,
"description":"This an optional field. Maximum length is 2000. It can be any characters here."
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- OBP-20057: User not found by userId.
- OBP-50000: Unknown Error.
Create My Api Collection Endpoint
Create Api Collection Endpoint.
glossary-item-not-found
Authentication is Mandatory
URL Parameters:
API_COLLECTION_NAME: Favourites
JSON request body fields:
operation_id: OBPv4.0.0-getBanks
JSON response body fields:
api_collection_endpoint_id: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
api_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
operation_id: OBPv4.0.0-getBanks
{
"api_collection_endpoint_id":"8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"operation_id":"OBPv4.0.0-getBanks"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
Create My Api Collection Endpoint By Id
Create Api Collection Endpoint By Id.
glossary-item-not-found
Authentication is Mandatory
URL Parameters:
API_COLLECTION_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON request body fields:
operation_id: OBPv4.0.0-getBanks
JSON response body fields:
api_collection_endpoint_id: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
api_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
operation_id: OBPv4.0.0-getBanks
{
"api_collection_endpoint_id":"8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"operation_id":"OBPv4.0.0-getBanks"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
Delete My Api Collection
Delete Api Collection By API_COLLECTION_ID
glossary-item-not-found
Authentication is Mandatory
URL Parameters:
API_COLLECTION_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
true
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20057: User not found by userId.
- OBP-50000: Unknown Error.
Delete My Api Collection Endpoint
glossary-item-not-found
Delete Api Collection Endpoint By OPERATION_ID
Authentication is Mandatory
URL Parameters:
API_COLLECTION_NAME: Favourites
OPERATION_ID: OBPv4.0.0-getBanks
JSON response body fields:
true
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20057: User not found by userId.
- OBP-50000: Unknown Error.
Delete My Api Collection Endpoint By Id
glossary-item-not-found
Delete Api Collection Endpoint By OPERATION_ID
Authentication is Mandatory
URL Parameters:
API_COLLECTION_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
OPERATION_ID: OBPv4.0.0-getBanks
JSON response body fields:
true
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20057: User not found by userId.
- OBP-50000: Unknown Error.
Delete My Api Collection Endpoint By Id
glossary-item-not-found
Delete Api Collection Endpoint
Delete Api Collection Endpoint By Id
Authentication is Mandatory
URL Parameters:
API_COLLECTION_ENDPOINT_ID: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
API_COLLECTION_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
true
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20057: User not found by userId.
- OBP-50000: Unknown Error.
Get All API Collections
Get All API Collections.
Authentication is Mandatory
JSON response body fields:
api_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
api_collection_name: Favourites
api_collections: api_collections
description: This an optional field. Maximum length is 2000. It can be any characters here.
is_sharable: is_sharable
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
{
"api_collections":[{
"api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"api_collection_name":"Favourites",
"is_sharable":true,
"description":"This an optional field. Maximum length is 2000. It can be any characters here."
}]
}
-
CanGetAllApiCollections
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.
- OBP-20001: User not logged in. Authentication is required!
Get Api Collection Endpoints
Get Api Collection Endpoints By API_COLLECTION_ID.
Authentication is Optional
URL Parameters:
API_COLLECTION_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
api_collection_endpoint_id: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
api_collection_endpoints: api_collection_endpoints
api_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
operation_id: OBPv4.0.0-getBanks
{
"api_collection_endpoints":[{
"api_collection_endpoint_id":"8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"operation_id":"OBPv4.0.0-getBanks"
}]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-50000: Unknown Error.
Get Api Collections for User
Get Api Collections for User.
Authentication is Mandatory
URL Parameters:
USER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
JSON response body fields:
api_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
api_collection_name: Favourites
api_collections: api_collections
description: This an optional field. Maximum length is 2000. It can be any characters here.
is_sharable: is_sharable
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
{
"api_collections":[{
"api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"api_collection_name":"Favourites",
"is_sharable":true,
"description":"This an optional field. Maximum length is 2000. It can be any characters here."
}]
}
-
CanGetApiCollectionsForUser
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20057: User not found by userId.
- OBP-50000: Unknown Error.
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
Get Featured Api Collections
Get Featured Api Collections.
Authentication is Optional
JSON response body fields:
api_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
api_collection_name: Favourites
api_collections: api_collections
description: This an optional field. Maximum length is 2000. It can be any characters here.
is_sharable: is_sharable
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
{
"api_collections":[{
"api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"api_collection_name":"Favourites",
"is_sharable":true,
"description":"This an optional field. Maximum length is 2000. It can be any characters here."
}]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-50000: Unknown Error.
Get My Api Collection By Id
Get Api Collection By API_COLLECTION_ID.
Authentication is Mandatory
URL Parameters:
API_COLLECTION_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
api_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
api_collection_name: Favourites
description: This an optional field. Maximum length is 2000. It can be any characters here.
is_sharable: is_sharable
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
{
"api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"api_collection_name":"Favourites",
"is_sharable":true,
"description":"This an optional field. Maximum length is 2000. It can be any characters here."
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20057: User not found by userId.
- OBP-50000: Unknown Error.
Get My Api Collection By Name
Get Api Collection By API_COLLECTION_NAME.
Authentication is Mandatory
URL Parameters:
API_COLLECTION_NAME: Favourites
JSON response body fields:
api_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
api_collection_name: Favourites
description: This an optional field. Maximum length is 2000. It can be any characters here.
is_sharable: is_sharable
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
{
"api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"api_collection_name":"Favourites",
"is_sharable":true,
"description":"This an optional field. Maximum length is 2000. It can be any characters here."
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20057: User not found by userId.
- OBP-50000: Unknown Error.
Get My Api Collection Endpoint
Get Api Collection Endpoint By API_COLLECTION_NAME and OPERATION_ID.
Authentication is Optional
URL Parameters:
API_COLLECTION_NAME: Favourites
OPERATION_ID: OBPv4.0.0-getBanks
JSON response body fields:
api_collection_endpoint_id: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
api_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
operation_id: OBPv4.0.0-getBanks
{
"api_collection_endpoint_id":"8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"operation_id":"OBPv4.0.0-getBanks"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20057: User not found by userId.
- OBP-50000: Unknown Error.
Get My Api Collection Endpoints
Get Api Collection Endpoints By API_COLLECTION_NAME.
Authentication is Mandatory
URL Parameters:
API_COLLECTION_NAME: Favourites
JSON response body fields:
api_collection_endpoint_id: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
api_collection_endpoints: api_collection_endpoints
api_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
operation_id: OBPv4.0.0-getBanks
{
"api_collection_endpoints":[{
"api_collection_endpoint_id":"8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"operation_id":"OBPv4.0.0-getBanks"
}]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20057: User not found by userId.
- OBP-50000: Unknown Error.
Get My Api Collection Endpoints By Id
Get Api Collection Endpoints By API_COLLECTION_ID.
Authentication is Mandatory
URL Parameters:
API_COLLECTION_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
api_collection_endpoint_id: 8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
api_collection_endpoints: api_collection_endpoints
api_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
operation_id: OBPv4.0.0-getBanks
{
"api_collection_endpoints":[{
"api_collection_endpoint_id":"8uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"operation_id":"OBPv4.0.0-getBanks"
}]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-20057: User not found by userId.
- OBP-50000: Unknown Error.
Get My Api Collections
Get all the apiCollections for logged in user.
Authentication is Mandatory
JSON response body fields:
api_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
api_collection_name: Favourites
api_collections: api_collections
description: This an optional field. Maximum length is 2000. It can be any characters here.
is_sharable: is_sharable
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
{
"api_collections":[{
"api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"api_collection_name":"Favourites",
"is_sharable":true,
"description":"This an optional field. Maximum length is 2000. It can be any characters here."
}]
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
Get Sharable Api Collection By Id
Get Sharable Api Collection By Id.
Authentication is Optional
URL Parameters:
API_COLLECTION_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
api_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
api_collection_name: Favourites
description: This an optional field. Maximum length is 2000. It can be any characters here.
is_sharable: is_sharable
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
{
"api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"api_collection_name":"Favourites",
"is_sharable":true,
"description":"This an optional field. Maximum length is 2000. It can be any characters here."
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-50000: Unknown Error.
Update My Api Collection By API_COLLECTION_ID
Update Api Collection for logged in user.
Authentication is Mandatory
URL Parameters:
API_COLLECTION_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
JSON response body fields:
api_collection_id: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
api_collection_name: Favourites
description: This an optional field. Maximum length is 2000. It can be any characters here.
is_sharable: is_sharable
user_id: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
{
"api_collection_id":"7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"api_collection_name":"Favourites",
"is_sharable":true,
"description":"This an optional field. Maximum length is 2000. It can be any characters here."
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- OBP-20057: User not found by userId.
- OBP-50000: Unknown Error.