REST API

GET: http://localhost:1248/api

Returns a list of the main APIs

• GET : http://localhost:1248/api/management

  Returns a list of all available management API's

  • GET : http://localhost:1248/api/management/version

    Returns product details

• GET : http://localhost:1248/api/workspaces

  Returns a list of all configured workspaces

  • GET : http://localhost:1248/api/workspaces/{workspaceName}

    Returns a list of all available workspace API's

  • POST : http://localhost:1248/api/workspaces/{workspaceName}?Path={workspaceDirectory}

    Register a new workspace

  • PUT : http://localhost:1248/api/workspaces/{workspaceName}?Path={workspaceDirectory}

    Update workspace directory

  • DELETE : http://localhost:1248/api/workspaces/{workspaceName}

    Remove workspace

  • GET : http://localhost:1248/api/workspaces/{workspaceName}/Inventory

    The report shows high-level statistics for source file types in the current workspace

  • GET : http://localhost:1248/api/workspaces/{workspaceName}/Projects

    List all available projects for the workspace

  • GET : http://localhost:1248/api/workspaces/{workspaceName}/CodeSearchReports

    List all available Code Search Reports

    • GET : http://localhost:1248/api/workspaces/{workspaceName}/CodeSearchReports/{reportName}

      Executes Code Search Report

  • GET : http://localhost:1248/api/workspaces/{workspaceName}/SourceSync

    Synchronize sources

  • GET : http://localhost:1248/api/workspaces/{workspaceName}/CheckQueueEmpty

    Checks whether the queue is empty

  • GET : http://localhost:1248/api/workspaces/{workspaceName}/Reports

    List all available reports for the workspace

    • GET : http://localhost:1248/api/workspaces/{workspaceName}/Reports/Executive

      The report provides HTML views of application inventories that a manager can use to assess the risks and costs of supporting the application

    • GET : http://localhost:1248/api/workspaces/{workspaceName}/Reports/Unresolved

      An Unresolved Report identifies missing application elements

    • GET : http://localhost:1248/api/workspaces/{workspaceName}/Reports/CrossRef

      A Cross-reference Report identifies all application references

    • GET : http://localhost:1248/api/workspaces/{workspaceName}/Reports/Unreferred

      An Unreferred Report identifies unreferenced application elements

    • GET : http://localhost:1248/api/workspaces/{workspaceName}/Reports/CRUD

      The report shows the data operations programs perform (Insert, Read, Update, or Delete) and the data objects on which the programs operate

  • GET : http://localhost:1248/api/workspaces/{workspaceName}/CodeSearch

    List all available mode

    • GET : http://localhost:1248/api/workspaces/{workspaceName}/CodeSearch/{model}

      List all available queries for the model

    • GET : http://localhost:1248/api/workspaces/{workspaceName}/CodeSearch/{model}/{criterion}

      Executing Code Search Searches

  • GET : http://localhost:1248/api/workspaces/{workspaceName}/CAWeb

    Returns a link to the workspace on CA Web if configured