Services and Endpoints

The API is organized into sets of endpoints that expose application functionality you can use to perform actions on application objects. For example, endpoints grouped under the Budget Item object category enable you to use the API to work with budget item data. Each endpoint consists of a unique URL and expected HTTP operation. To use the functionality exposed by an endpoint, you must form an HTTP request containing any required data and send it to the specified URL using the specified operation.

Note: If you attempt to access a URL that is not associated with a valid endpoint, or you attempt to use an HTTP operation an endpoint does not support, the API will return an error.

Quick Start

You can access the API using a variety of tools, such as curl. Run the following curl command to connect to the API. If the command runs successfully, the API server will return a JSON object containing all integrated projects in the application environment.

Note: Text surrounded in < > indicates a variable. You must replace variables with your own data to run the examples in this documentation.

curl Command

curl -u <username>:<password> -X GET -H "Accept:application/json" https://<host>:<port>/primeapi/restapi/project/externallySourced

The variables in the previous example should be replaced with the following information when accessing the API:

• <username>: The username of an application user. This user will be used to access the API and must have permission to access requested application data. For example, jsmith.
• <password>: The password associated with the user account used to access the API.
• <host>: The name of the host on which the application is deployed. For example, localhost.
• <port>: The port number assigned to the application on the application host. For example, 7001.

Example Response Data

[ 
          { 
              "projectCurrencyCode": "USD", 
              "workspaceCode": "Example Workspace", 
              "parentProject": 30002, 
              "securityGuid": "639D4D57AA960E25E0533113C40A4896", 
              "workspaceId": 30002, 
              "sourceId": "1", 
              "recordCount": 1, 
              "projectId": 36103, 
              "manager": "Example User", 
              "description": "Example Description", 
              "status": "ACTIVE", 
              "projectConfiguredFields": { 
                  "projectId": 36103, 
                  "costFlexMap": {}, 
                  "textFlexMap": {}, 
                  "otherFlexMap": {}, 
                  "updateDate": "2018-01-25T16:30:51" 
              } 
      ...more project properties 
      ]