Jump to

• Request
• Response

1a Compliance Requirements

post

/api/v1/import/compliance-requirements

Compliance Requirement(s) imported through this API with a unique combination of MainJobNumber and Description will be created on the Project as Document Requirements. The compliance status imported through this API will update a subcontractor status for the specified requirement on a project, based on ContractNumber, VendorId, and MainJobNumber. In order to create requirements through import your organization must be enabled to do so by a Textura Account Manager.

Request

Header Parameters

• Authentification(required):
  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

• ContractNumber: string
  Maximum Length: 500

  Subcontract or Purchase Order Number.

  Example: 001
• Description: string
  This is a fixed value for each description. This is actually a key value that Textura uses and needs to stay constant.

  Example: General Liability Insurance
• DocumentId: string
  ID Number, can be used for policy number or left blank

  Example: 15643
• ExpirationDate: string
  Date Expired - if blank, does not expire

  Example: 04272015
• IssueDate: string
  Date the requirement was received

  Example: 03052015
• MainJobNumber: string
  Maximum Length: 300

  The project/job this subcontract is written against.

  Example: 24290012
• Status: string
  1 = Not Received, 2 = Received, 3 = Set requirement to Not Tracking

  Example: 2
• VendorId: string
  Maximum Length: 200

  Master Vendor ID for the AP entry

  Example: ALLIED

{
    "type":"object",
    "properties":{
        "ContractNumber":{
            "type":"string",
            "description":"Subcontract or Purchase Order Number.",
            "maxLength":500,
            "example":"001",
            "nullable":true
        },
        "VendorId":{
            "type":"string",
            "description":"Master Vendor ID for the AP entry",
            "maxLength":200,
            "example":"ALLIED",
            "nullable":true
        },
        "Description":{
            "type":"string",
            "description":"This is a fixed value for each description.  This is actually a key value that Textura uses and needs to stay constant.",
            "example":"General Liability Insurance",
            "nullable":true
        },
        "DocumentId":{
            "type":"string",
            "description":"ID Number, can be used for policy number or left blank",
            "example":"15643",
            "nullable":true
        },
        "IssueDate":{
            "type":"string",
            "description":"Date the requirement was received",
            "example":"03052015",
            "nullable":true
        },
        "ExpirationDate":{
            "type":"string",
            "description":"Date Expired - if blank, does not expire",
            "example":"04272015",
            "nullable":true
        },
        "MainJobNumber":{
            "type":"string",
            "description":"The project/job this subcontract is written against.",
            "maxLength":300,
            "example":"24290012",
            "nullable":true
        },
        "Status":{
            "type":"string",
            "description":"1 = Not Received, 2 = Received, 3 = Set requirement to Not Tracking",
            "example":"2",
            "nullable":true
        }
    }
}

Examples

Select an example Project Compliance Requirements Payload

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/compliance-requirements/930

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

Examples

Select an example Project compliance response Project compliance response

Default Response

Links to working URLs

Links

Production URL

https://services.texturacorp.com/ebis/api/v1/import/compliance-requirements

Test URL

https://usint1.textura.oraclecloud.com/ebis/api/v1/import/compliance-requirements

Back to Top