Infor API | InforBirstRestAPI

Infor Birst Rest API

Sections

Infor Birst Rest API
Account Groups
- GET
  Gets all Account Groups
- POST
  Create an Account Group
- GET
  Gets particular Account Group details
- PUT
  Update an Account Group
- DELETE
  Deletes particular Account Group
Account Groups ACLs
- PUT
  Add permissions to Account Group
- DELETE
  Remove permissions to account group
Account Groups Features
- GET
  Get list of features
- PUT
  Add features to Account Group
- PUT
  Add feature to Account Group
- DELETE
  Remove feature from Account Group
Account Groups Spaces
- PUT
  Add Account Group to space
- DELETE
  Delete Account Group from space
- GET
  Get Account Groups for space
Account Groups Users
- GET
  Get users present in account group
- POST
  Add users in account group
- DELETE
  Remove users from account group
- POST
  Add user to Account Group
- DELETE
  Remove user from account group
Jobs
- GET
  Get Job Status
- POST
  Perform action on a Job
Spaces
- GET
  Get the list of spaces for an Account
- POST
  Create a Space
- GET
  Get the details of a given Space
- PUT
  Update a Space
- DELETE
  Delete a Space
- POST
  Perform an action on a Space
- POST
  Execute a query in a space.
Space Catalog
- GET
  Get the details of the catalog entities for a given space
- POST
  Create a Space Catalog Directory
- GET
  Get the details of a Space Catalog Entity
- DELETE
  Delete a Space Catalog Entity
- POST
  Perform an action on a Space Catalog Entity
- GET
  Get the details of a Space Catalog Entity Permissions
- POST
  Search for Space Catalog Entity
Space Collections
- GET
  Get a list of collections for a given space
- POST
  Create an empty collection in a given space
- GET
  Get the details of a collection
- PATCH
  Update name and type of a collection
Space Collection Dashboards
- GET
  Get a list of dashboards for a given collection
- GET
  Get the details of a dashboard
- POST
  Perform an action on a Dashboard
Space Localizations
- GET
  Get Space Localizations
- POST
  Create Space Localization
- GET
  Get Space Localization
- PATCH
  Update Space Localization
- DELETE
  Delete Space Localization
- GET
  Get Space Localizations Defaults
Space Reports
- GET
  Get Reports
- GET
  Get Report
- POST
  Perform action on Space Report Entity
Space Groups
- GET
  Get a list of Space Groups for a given space
- POST
  Create a Space Group
- GET
  Get a specific Space Group
- PUT
  Update a Space Group
- DELETE
  Delete a Space Group
Space Group Users
- GET
  Get a list of users for a given Space Group
- POST
  Add a user to a space group
- GET
  Get the details of a user in a Space Group
- DELETE
  Delete a User from a given Space Group
Space Group ACLs
- GET
  Get a list of ACLs for a Space Group
- POST
  Add an ACL to a Space Group
- GET
  Get the details of an ACL for a Space Group
- DELETE
  Delete an ACL from a Space Group
Space Sources
- GET
  Get Space Sources
- POST
  Create Source
- GET
  Get Space Source details
- PUT
  Update Source
- DELETE
  Delete source
Space Users
- GET
  Get a list of users in a Space
- POST
  Add a User to a Space
- GET
  Get the details of a user in a Space
- PATCH
  Update a Space User's Role
- DELETE
  Delete a User from a given Space
- GET
  Get a list of a space user's groups
Space Variables
- GET
  Get Variables
- POST
  Create Variable
- GET
  Get Variable
- PUT
  Update Variable
- DELETE
  Delete Variable
- POST
  Perform action on Variables
Space Connections
- GET
  Get Connections
Space Level Connections
- GET
  Get Space Level Connections
- POST
  Create Space Level Connection
- PUT
  Update Space Level Connection
- DELETE
  Delete Space Level Connection
- POST
  Test Space Level Connection
Space Hierarchies
- POST
  Create a new hierarchy
- GET
  Get all hierarchies
- GET
  Gets particular Hierarchy details
- PUT
  Update a Hierarchy
- DELETE
  Deletes particular Hierarchy
- POST
  Create a new level
- PUT
  Update a Level
- DELETE
  Deletes particular level
Space Security filter
- POST
  Create a new Security filter
- GET
  Get all Security filters
- GET
  Gets particular security filter details
- PUT
  Update a Security filter
- DELETE
  Deletes particular Security filter
ACLs
- GET
  Get a list of ACLs
Shared Connections
- GET
  Get Shared Connections
- POST
  Create Shared Connection
- PUT
  Update Shared Connection
- DELETE
  Delete Shared Connection
- POST
  Test a Shared Connection
Users
- GET
  Get the list of users for an Account
- POST
  Create a new user
- GET
  Get the details of a user
- PUT
  Update a user
User Bulk Actions
- PUT
  Perform an action on a users
- POST
  Create multiple users
User Settings
- GET
  Get the locale set for the user
- PUT
  Update the user locale in the user settings
User Spaces
- POST
  Add a user to multiple spaces
Workflows
- GET
  Returns workflows in this account
- POST
  Create a new workflow
- GET
  Returns specified workflow
- PUT
  Update an existing workflow
- DELETE
  Deletes specified workflow
Workflow Runs
- GET
  Returns the workflow run details for the current and past runs
- GET
  Returns the workflow run details for the particular runs
- POST
  Immediately triggers workflow execution
- POST
  Submits request to cancel workflow execution.
Workflow Schedules
- GET
  Returns all schedules of the given workflow
- POST
  Creates a new workflow schedule
- GET
  Returns specified schedule
- PUT
  Edits the given workflow schedule
- DELETE
  Deletes the given workflow schedule
Import Package
- GET
  Returns all imported packages in space
- GET
  Returns all Available packages for space to Import
- POST
  Import Package into Child Space
- GET
  Returns details of Imported Package
- DELETE
  Delete/Disconnect Imported Package From Space
ComplexJoins
- GET
  Returns all sources along with joins
- POST
  Create Join
- DELETE
  Delete Join
- PUT
  Update Join
- GET
  Returns Dataflow Details
Package
- GET
  Returns All Packages for Space
- POST
  Create Package
- PUT
  Update Package
- GET
  Returns Package Details
- DELETE
  Delete Package
Agent
- GET
  List Agents
- POST
  Register Agent
- GET
  Get Agent Health Details
- PUT
  Upgrade Agent
- PUT
  Updates Agent Details
- DELETE
  Delete Agent
Extraction Objects
- POST
  Add Object
- GET
  Retrieve saved objects