Previous Next JavaScript must be enabled to correctly display this content

## Structure Maintenance API REST Endpoints

Sort by
Task Path Method
Structure Services/Structure Maintenance API
This service is used for structure maintenance operation.

Adds a new structure
  Method: post
  Path: `/structure`
Adds a new structure from external system
  Method: post
  Path: `/structure/createExternal`
Adds a new structure from simulated structure
  Method: post
  Path: `/structure/createFromSimulation`
Authorize the structure by given ID
  Method: patch
  Path: `/structure/{id}/approve`
Close the structure by given ID
  Method: patch
  Path: `/structure/{id}/close`
Deletes the structure identified by given ID
  Method: delete
  Path: `/structure/{id}`
Export an a structure
  Method: get
  Path: `/structure/{id}/export/{format}`
Fetch all the accounts of a structure by given ID
  Method: get
  Path: `/structure/{id}/accounts`
Fetch Structure Account Priority's for the given account
  Method: get
  Path: `/structure/priorities`
Fetch Structure Account Priority's for the given account
  Method: get
  Path: `/structure/priority/{accountNumber}`
Fetch Structure Account Priority's for the given accounts
  Method: get
  Path: `/structure/priorities/accountNumbers/{accountNumbers}`
For a given intruction ID or frequency, validates whether there are open structures
  Method: get
  Path: `/structure/checkStructureExists`
Get all structure that are going to expire within n days
  Method: post
  Path: `/structure/expiry`
Get all valid simulation structure
  Method: get
  Path: `/structure/simulation`
Get all valid structure
  Method: get
  Path: `/structure`
Get structure logs to view, authorize or reject
  Method: get
  Path: `/structure/approval`
Modifies a structure from external system
  Method: post
  Path: `/structure/modifyExternal`
Reject the structure by given ID
  Method: patch
  Path: `/structure/{id}/reject`
Reopen the structure by given ID
  Method: patch
  Path: `/structure/{id}/reopen`
Retrieves active VA count for the input real customer with structure
  Method: post
  Path: `/structure/vacountperstrcustomer`
Retrieves the BOD structure master ID by header branch code
  Method: get
  Path: `/structure/structureBod/{headerBranchCode}`
Retrieves the reallocation structure details by header branch code
  Method: get
  Path: `/structure/strRealloc/{headerBranchCode}`
Retrieves the structure by ID
  Method: get
  Path: `/structure/fetch/{id}`
Retrieves the structure by ID.
  Method: get
  Path: `/structure/{id}`
Retrieves the structure for EOD by header branch code
  Method: get
  Path: `/structure/structureEod/{headerBranchCode}`
Retrieves the structure for pool by header branch code
  Method: get
  Path: `/structure/poolstructure/{headerBranchCode}`
Retrieves the structure ID
  Method: get
  Path: `/structure/getStructureId`
Retrieves the structure ID and simulation ID
  Method: get
  Path: `/structure/simulation/getSimulationId`
Retrieves the structure Master ID by header branch code reverse sweep
  Method: get
  Path: `/structure/strRevSweep/{headerBranchCode}`
Retrieves the structure master ID by next run date
  Method: get
  Path: `/structure/structureIntraDay`
Retrieves the structure master ID by next run date for reverse sweep
  Method: get
  Path: `/structure/strRevSweepIntraDay`
Retrieves the structure master ID by next run date reverse
  Method: get
  Path: `/structure/revFreqStructure`
Retrives the structure by given ID
  Method: get
  Path: `/structure/{id}/history`
Retrives the structure by given ID
  Method: get
  Path: `/structure/{id}/unauthorized`
Update an existing structure
  Method: put
  Path: `/structure/{id}`
Update an existing structure with validation
  Method: put
  Path: `/structure/submit/{id}`
Update last successful sweep for given structure
  Method: patch
  Path: `/structure/{structureId}/last-successful-sweep-date`
Update next run date for given structure
  Method: post
  Path: `/structure/updateNextRunDate`
Update structure status of existing structures
  Method: put
  Path: `/structure/updateStructureStatus/{headerBranchCode}`
Validates a new structure
  Method: post
  Path: `/structure/validate`