Jump to

• Request
• Response

1a Projects

post

/api/v1/import/projects

This API will create a new project in Textura, by using an existing project template. The user must reference an existing template name when using this API. A project template can be created by users within Textura. A user can do this by creating a project in Textura and selecting Template Project. This will create a template project that can now be referenced when sending a POST request to this API. Additionally, a user will be able to create a template project by selecting another template or project. Other details must also be included in the POST payload, please refer to parameter section below to see required parameters.

Request

Header Parameters

• Authentification(required): string
  The protocol for the API requires a valid username and password for TPM.

Supported Media Types

• application/json

Request Body - application/json ()

• application/json

Root Schema : schema

Type: object

Show Source

• city(required): string
  Owner City

  Example: Middletown
• copyApproval: string
  Copies Approval setup from Template Project (true/false)

  Example: false
• countryCode(required): string
  Owner Country Code

  Example: US
• estimatedCompletionDate(required): string
  Estimate Completion Date of the project

  Example: 2022-02-01T16:00:05Z
• estimatedStartDate(required): string
  Start Date of the project

  Example: 2021-01-02T16:00:05Z
• includeCompliance: string
  Copies compliance requirements from Template Project

  Example: true
• name(required): string
  Project Name

  Example: Mukti-Vinod test
• number(required): string
  Project Number

  Example: 01-190424
• postalCode(required): string
  Owner Zip Code

  Example: 02842
• siteName: string
  Project Site Name

  Example: 123 Main Street
• state(required): string
  Project State

  Example: RI
• street1(required): string
  Owner Address 1

  Example: 123 Main Street
• street2: string
  Owner Address 2

  Example: oracle.doceng.json.BetterJsonNull@4e858e0a
• templateName(required): string
  Name of the Project Template in TPM

  Example: cbretest
• value(required): number
  Project Value

  Example: 8000000

{
    "required":[
        "estimatedStartDate",
        "name",
        "templateName",
        "estimatedCompletionDate",
        "number",
        "value",
        "city",
        "countryCode",
        "street1",
        "state",
        "postalCode"
    ],
    "type":"object",
    "properties":{
        "estimatedStartDate":{
            "type":"string",
            "description":"Start Date of the project",
            "example":"2021-01-02T16:00:05Z",
            "nullable":false
        },
        "name":{
            "type":"string",
            "description":"Project Name",
            "example":"Mukti-Vinod test",
            "nullable":false
        },
        "copyApproval":{
            "type":"string",
            "description":"Copies Approval setup from Template Project (true/false)",
            "example":"false",
            "nullable":true
        },
        "templateName":{
            "type":"string",
            "description":"Name of the Project Template in TPM",
            "example":"cbretest",
            "nullable":false
        },
        "siteName":{
            "type":"string",
            "description":"Project Site Name",
            "example":"123 Main Street",
            "nullable":true
        },
        "estimatedCompletionDate":{
            "type":"string",
            "description":"Estimate Completion Date of the project",
            "example":"2022-02-01T16:00:05Z",
            "nullable":false
        },
        "number":{
            "type":"string",
            "description":"Project Number",
            "example":"01-190424",
            "nullable":false
        },
        "value":{
            "type":"number",
            "description":"Project Value",
            "example":"8000000",
            "nullable":false
        },
        "includeCompliance":{
            "type":"string",
            "description":"Copies compliance requirements from Template Project",
            "example":"true",
            "nullable":true
        },
        "city":{
            "type":"string",
            "description":"Owner City",
            "example":"Middletown",
            "nullable":false
        },
        "countryCode":{
            "type":"string",
            "description":"Owner Country Code",
            "example":"US",
            "nullable":false
        },
        "street1":{
            "type":"string",
            "description":"Owner Address 1",
            "example":"123 Main Street",
            "nullable":false
        },
        "street2":{
            "type":"string",
            "description":"Owner Address 2",
            "example":null,
            "nullable":true
        },
        "state":{
            "type":"string",
            "description":"Project State",
            "example":"RI",
            "nullable":false
        },
        "postalCode":{
            "type":"string",
            "description":"Owner Zip Code",
            "example":"02842",
            "nullable":false
        }
    }
}

Examples

Select an example Import projects request

Back to Top

Response

Supported Media Types

• application/json

200 Response

The job was successfully created.

Body ()

Root Schema : schema

Type: object

Show Source

• URI: string
  Endpoint for job-audit retrieval

  Example: https://services.texturacorp.com/ebis/api/v1/import/projects/42

{
    "type":"object",
    "properties":{
        "URI":{
            "type":"string",
            "description":"Endpoint for job-audit retrieval",
            "example":"https://services.texturacorp.com/ebis/api/v1/import/projects/42",
            "nullable":true
        }
    }
}

Examples

Select an example Production Server: Import projects response Test Server: Import projects response

Default Response

Links to working URLs

Links

Production URL

https://services.texturacorp.com/ebis/api/v1/import/projects

Test URL

https://usint1.texturacorp.com/ebis/api/v1/import/projects

Back to Top