Getting StartedAPI Reference
API Reference

Executes the Add action for the Potential Projects data object.

post
https://api.xchange.trimble.com/connect/v1/direct/subscribers//vista/pc/2/data/potential_projects/actions/add

Adds a new Potential Project record.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The code of the subscriber that you are making this request for.

Body Params
integer
required

Job Cost Company ID.

string
required
length ≤ 20

The unique identifier for the potential project.

string | null

A description of the potential project.

integer | null

The Project Manager's ID.

string
^[-+]?[0-9]{1,2}(?:.[0-9]{0,4})?$

Go probability percentage.

string
^[-+]?[0-9]{1,2}(?:.[0-9]{0,4})?$

Award probability percentage.

string
^[-+]?[0-9]{1,10}(?:.[0-9]{0,2})?$

Projected chase amount.

date

The project start date. Format: YYYY-MM-DD

date

The project completion date. Format: YYYY-MM-DD

string
^[-+]?[0-9]{1,10}(?:.[0-9]{0,2})?$

Estimated revenue.

string
^[-+]?[0-9]{1,10}(?:.[0-9]{0,2})?$

Estimated cost.

string
^[-+]?[0-9]{1,10}(?:.[0-9]{0,2})?$

Estimated profit.

string
enum
length ≤ 1

Indicates if forecasting is allowed. Options: Y-Yes, N-No.

Allowed:
string
length ≤ 1

Indicates if the project has been awarded.

string | null

The date the project was awarded. Format: YYYY-MM-DD

string | null

Contract identifier.

string | null

General notes about the project.

string | null
[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}
string | null

Detailed project information.

string | null

The type of project.

string | null

The status of the project.

string | null

Job site street address.

string | null

Job site city.

string | null

Job site state.

string | null

Job site zip code.

string | null

Job site region.

string | null

URL to project documents.

string | null

Other plan location for documents.

integer | null

Vendor group ID.

string | null
^[-+]?[0-9]{1,9}(?:.[0-9]{0,3})?$

The size of the project.

string | null

Unit of measurement for project size.

string | null

The type of work.

string | null

The type of client.

string | null
^[-+]?[0-9]{1,10}(?:.[0-9]{0,2})?$

The total value of the project.

string | null
enum

Prime or Subcontractor status. Options: P-Prime, S-Sub.

Allowed:
string | null
enum

Type of contract. Options: G-Guaranteed Maximum Price, L-Lump Sum, T-Time and Materials, C-Cost Plus, U-Unit Price.

Allowed:
string | null
enum

Result of the bid. Options: P-Pending, L-Lost, W-Won, C-Project Canceled, D-Did Not Bid.

Allowed:
string | null

Date the bid was awarded. Format: YYYY-MM-DD

string | null

Name of a competitor.

string | null
^[-+]?[0-9]{1,10}(?:.[0-9]{0,2})?$

The competitor's bid amount.

string | null

Job site country.

__BidInfo
object
required
__ProjectTeam
array of objects

Schema for an array of PCPotentialProjectTeam objects to be used in an endpoint.

PCPotentialProjectTeamArray
__custom_fields
object

This property will be added if there are any custom fields defined for this object in Vista. Each custom field will be a property of this object.

Headers
string
required

Used to authorize access to the Direct API.

Responses

401

You have not provided a proper X-Application-Key in the header of this request.

403

The X-Application-Key provided is valid but the key does not have access to this resource.

404

The object with the given ID was not found OR a subscriber with the given URL was not found.

Updated 4 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago