Offered APIs¶
The following API calls are available for the PORTAL Platform subsystem: .. _offeredapis:
Changed the V1 api’s to V3 api’s as a part of API versioning of ONAP components.
PORTAL API Services¶
PORTAL API Details¶
scheduler-controller¶
GET /auxapi/get_time_slots/{scheduler_request}
getTimeSlots
Consumes: [‘application/json’]
Produces: [‘*/*’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
scheduler_request |
path |
scheduler_request |
string |
Responses
200 - OK
401 - Unauthorized
403 - Forbidden
404 - Not Found
POST /auxapi/post_create_new_vnf_change
postCreateNewVNFChange
Consumes: [‘application/json’]
Produces: [‘*/*’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
scheduler_request |
body |
scheduler_request |
Responses
200 - OK
201 - Created
401 - Unauthorized
403 - Forbidden
404 - Not Found
POST /auxapi/submit_vnf_change_timeslots
postSubmitVnfChangeTimeslots
Consumes: [‘application/json’]
Produces: [‘*/*’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
scheduler_request |
body |
scheduler_request |
Responses
200 - OK
201 - Created
401 - Unauthorized
403 - Forbidden
404 - Not Found
external-apps-restful-controller¶
GET /auxapi/functionalMenuItemsForUser
getFunctionalMenuItemsForUser
Consumes: [‘application/json’]
Produces: [‘application/json’]
Responses
200 - OK
401 - Unauthorized
403 - Forbidden
404 - Not Found
GET /auxapi/getFavorites
getFavoritesForUser
Consumes: [‘application/json’]
Produces: [‘application/json’]
Responses
200 - OK
401 - Unauthorized
403 - Forbidden
404 - Not Found
external-access-roles-controller¶
GET /auxapi/activeRoles
Gets active roles for an application.
Consumes: [‘application/json’]
Produces: [‘application/json’]
Responses
200 - OK
401 - Unauthorized
403 - Forbidden
404 - Not Found
DELETE /auxapi/deleteDependcyRoleRecord/{roleId}
deletes user roles for an application.
Consumes: [‘application/json’]
Produces: [‘application/json’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
roleId |
path |
roleId |
integer |
Responses
200 - OK
204 - No Content
401 - Unauthorized
403 - Forbidden
DELETE /auxapi/deleteRole/{code}
Deletes role for an application.
Consumes: [‘application/json’]
Produces: [‘application/json’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
code |
path |
code |
string |
Responses
200 - OK
204 - No Content
401 - Unauthorized
403 - Forbidden
GET /auxapi/function/{code}
Gets role information for an application provided by function code.
Consumes: [‘application/json’]
Produces: [‘application/json’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
code |
path |
code |
string |
Responses
200 - OK
401 - Unauthorized
403 - Forbidden
404 - Not Found
GET /auxapi/functions
Gets all role functions for an application.
Consumes: [‘application/json’]
Produces: [‘application/json’]
Responses
200 - OK
401 - Unauthorized
403 - Forbidden
404 - Not Found
GET /auxapi/menuFunctions
Gets all functions along with global functions
Consumes: [‘application/json’]
Produces: [‘application/json’]
Responses
200 - OK
401 - Unauthorized
403 - Forbidden
404 - Not Found
POST /auxapi/role
Saves role for an application.
Consumes: [‘application/json’]
Produces: [‘application/json’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
role |
body |
role |
Responses
200 - OK
201 - Created
401 - Unauthorized
403 - Forbidden
404 - Not Found
GET /auxapi/role/{role_id}
Gets role information for an application.
Consumes: [‘application/json’]
Produces: [‘application/json’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
role_id |
path |
role_id |
integer |
Responses
200 - OK
401 - Unauthorized
403 - Forbidden
404 - Not Found
POST /auxapi/roleFunction
Saves role function for an application.
Consumes: [‘application/json’]
Produces: [‘application/json’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
roleFunc |
body |
roleFunc |
Responses
200 - OK
201 - Created
401 - Unauthorized
403 - Forbidden
404 - Not Found
DELETE /auxapi/roleFunction/{code}
Deletes role function for an application.
Consumes: [‘application/json’]
Produces: [‘application/json’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
code |
path |
code |
string |
Responses
200 - OK
204 - No Content
401 - Unauthorized
403 - Forbidden
GET /auxapi/roles
Gets roles for an application.
Consumes: [‘application/json’]
Produces: [‘application/json’]
Responses
200 - OK
401 - Unauthorized
403 - Forbidden
404 - Not Found
POST /auxapi/upload/partner/functions
Bulk upload functions for an partner application.
Consumes: [‘application/json’]
Produces: [‘application/json’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
upload |
body |
upload |
Responses
200 - OK
201 - Created
401 - Unauthorized
403 - Forbidden
404 - Not Found
POST /auxapi/upload/partner/roleFunctions
Bulk upload role functions for an partner application.
Consumes: [‘application/json’]
Produces: [‘application/json’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
upload |
body |
upload |
Responses
200 - OK
201 - Created
401 - Unauthorized
403 - Forbidden
404 - Not Found
POST /auxapi/upload/partner/roles
Bulk upload roles for an partner application.
Consumes: [‘application/json’]
Produces: [‘application/json’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
upload |
body |
upload |
Responses
200 - OK
201 - Created
401 - Unauthorized
403 - Forbidden
404 - Not Found
POST /auxapi/upload/portal/functions
Bulk upload functions for an application.
Consumes: [‘application/json’]
Produces: [‘application/json’]
Responses
200 - OK
201 - Created
401 - Unauthorized
403 - Forbidden
404 - Not Found
POST /auxapi/upload/portal/roleFunctions
Bulk upload role functions for an application.
Consumes: [‘application/json’]
Produces: [‘application/json’]
Responses
200 - OK
201 - Created
401 - Unauthorized
403 - Forbidden
404 - Not Found
POST /auxapi/upload/portal/roles
Bulk upload roles for an application.
Consumes: [‘application/json’]
Produces: [‘application/json’]
Responses
200 - OK
201 - Created
401 - Unauthorized
403 - Forbidden
404 - Not Found
POST /auxapi/upload/portal/userRoles
Bulk upload user roles for an application.
Consumes: [‘application/json’]
Produces: [‘application/json’]
Responses
200 - OK
201 - Created
401 - Unauthorized
403 - Forbidden
404 - Not Found
GET /auxapi/user/{loginId}
Gets user role for an application.
Consumes: [‘application/json’]
Produces: [‘application/json’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
loginId |
path |
loginId |
string |
Responses
200 - OK
401 - Unauthorized
403 - Forbidden
404 - Not Found
GET /auxapi/users
Gets all active Users of application
Consumes: [‘application/json’]
Produces: [‘application/json’]
Responses
200 - OK
401 - Unauthorized
403 - Forbidden
404 - Not Found
session-communication-controller¶
POST /auxapi/extendSessionTimeOuts
Extends session timeout values for all on-boarded applications.
Consumes: [‘application/json’]
Produces: [‘*/*’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
sessionMap |
query |
sessionMap |
string |
Responses
200 - OK
201 - Created
401 - Unauthorized
403 - Forbidden
404 - Not Found
GET /auxapi/getSessionSlotCheckInterval
Gets session slot-check interval, a duration in milliseconds.
Consumes: [‘application/json’]
Produces: [‘application/json’]
Responses
200 - OK
401 - Unauthorized
403 - Forbidden
404 - Not Found
web-analytics-ext-app-controller¶
GET /auxapi/analytics
Gets javascript with functions that support gathering and reporting web analytics.
Consumes: [‘application/json’]
Produces: [‘application/javascript’]
Responses
200 - OK
401 - Unauthorized
403 - Forbidden
404 - Not Found
POST /auxapi/storeAnalytics
Accepts data from partner applications with web analytics data.
Consumes: [‘application/json’]
Produces: [‘application/json’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
analyticsMap |
body |
analyticsMap |
Responses
200 - OK
201 - Created
401 - Unauthorized
403 - Forbidden
404 - Not Found
policy-controller¶
POST /auxapi/get_policy
getPolicyInfo
Consumes: [‘application/json’]
Produces: [‘*/*’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
policy_request |
body |
policy_request |
Responses
200 - OK
201 - Created
401 - Unauthorized
403 - Forbidden
404 - Not Found
apps-controller-external-request¶
POST /auxapi/onboardApp
Adds a new application to Portal.
Consumes: [‘application/json’]
Produces: [‘application/json’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
newOnboardApp |
body |
newOnboardApp |
Responses
200 - OK
201 - Created
401 - Unauthorized
403 - Forbidden
404 - Not Found
GET /auxapi/onboardApp/{appId}
Gets the specified application that is on-boarded in Portal.
Consumes: [‘application/json’]
Produces: [‘application/json’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
appId |
path |
appId |
integer |
Responses
200 - OK
401 - Unauthorized
403 - Forbidden
404 - Not Found
PUT /auxapi/onboardApp/{appId}
Updates information about an on-boarded application in Portal.
Consumes: [‘application/json’]
Produces: [‘application/json’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
appId |
path |
appId |
integer |
oldOnboardApp |
body |
oldOnboardApp |
Responses
200 - OK
201 - Created
401 - Unauthorized
403 - Forbidden
404 - Not Found
POST /auxapi/portalAdmin
Creates a new user as a Portal administrator.
Consumes: [‘application/json’]
Produces: [‘application/json’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
epUser |
body |
epUser |
Responses
200 - OK
201 - Created
401 - Unauthorized
403 - Forbidden
404 - Not Found
ticket-event-controller¶
POST /auxapi/ticketevent
Accepts messages from external ticketing systems and creates notifications for Portal users.
Consumes: [‘application/json’]
Produces: [‘*/*’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
ticketEventJson |
body |
ticketEventJson |
Responses
200 - OK
201 - Created
401 - Unauthorized
403 - Forbidden
404 - Not Found
roles-approval-system-controller¶
POST /auxapi/userProfile
Creates an application user with the specified roles.
Consumes: [‘application/json’]
Produces: [‘application/json’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
extSysUser |
body |
extSysUser |
Responses
200 - OK
201 - Created
401 - Unauthorized
403 - Forbidden
404 - Not Found
PUT /auxapi/userProfile
Updates an application user to have only the specified roles.
Consumes: [‘application/json’]
Produces: [‘application/json’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
extSysUser |
body |
extSysUser |
Responses
200 - OK
201 - Created
401 - Unauthorized
403 - Forbidden
404 - Not Found
DELETE /auxapi/userProfile
Processes a request to delete one or more application roles for one specified user who has roles.
Consumes: [‘application/json’]
Produces: [‘application/json’]
Parameters
Name |
Position |
Description |
Type |
|---|---|---|---|
extSysUser |
body |
extSysUser |
Responses
200 - OK
204 - No Content
401 - Unauthorized
403 - Forbidden
Additional Information¶
Additional information, including examples, can be found at PortalApi link.
End of Document