Creating Procurement Workspace Projects Using the API

The Create Procurement Workspace API allows client applications to create procurement workspace projects in guided buying using this procedure.

Context

If your organization has many projects to create, it's simpler, quicker, and more accurate to use an automated solution to create them.

This API creates empty projects in guided buying.

Procedure

  1. Your organization identifies a business need that requires the creation of a procurement workspace project.
  2. The client application gathers business-oriented attributes that will define the procurement workspace project and constructs a body element in JSON format that can be used as the body of the API query.
  3. The client application creates the project by passing the body element to the POST /ProcurementWorkspaces endpoint:
    POST {{runtime_url}}/ProcurementWorkspaces
    Request Body:
    {
       "TemplateId": "PW12345",
       "Title": "Summer Sales Kick-off Event",
       "Description": "Project to track all expenses related to the Summer Sales
    	 Kick-off Event, including the party at the resort",
       "IsSubProject": false,
       "ProcurementType": "Strategy and Analysis",
       "PricingStructure": "FixedFee",
       "BaseLanguage": "en",
       "ProcurementStartDate": "2023-10-21",
       "ProcurementEndDate": "2025-10-21",
       "ProjectDeliverables": "Summer Sales Kick-off Event",
       "SourceApplicationSite": "ACMECorporateSite",
       "IsTest": false,
       "Client": {
          "DepartmentID": "100"
       },
       "Suppliers": {
          "SystemID": "sid480"
       },
       "Commodity": {
          "Domain": "unspsc",
          "UniqueName": "53"
       },
       "ProjectLead": {
          "UniqueName": "areed",
          "PasswordAdapter": "PasswordAdapter1"
       },
       "Owner": {
          "UniqueName": "areed",
          "PasswordAdapter": "PasswordAdapter1"
       },
       "Region": {
          "UniqueName": "APAC" 
       }
    }

    For descriptions and permissible values of these fields, see the swagger documentation for this API.

Results

After your client application creates an empty procurement workspace project, guided buying users can use the user interface to add documents (such as request, invoices, or other projects) to it.