Jump to

• Request
• Response

1b Compliance Requirements Audit

get

/api/v1/import/compliance-requirements/{jobID}

Grabs an audit file for a Compliance Requirements job, if the audit file exists.

Request

Path Parameters

• jobID(required): integer(int64)
  Unique identifier of the job number.

Header Parameters

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

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The job was successfully created.

Body ()

Root Schema : schema

Type: object

Show Source

• formattedMessage: string
  Example: 'Worker's Comp' is set to Received for Arrange Engineering for contract number DA34-019:0010
• isoDateTime: string
  Example: 2023-02-02T12:24:17.215807
• mainJobNumber: string
  Example: DA-DA34-019
• newRequirementStatus: string
  Example: Received
• requirementName: string
  Example: Worker's Comp
• status: string
  Example: SUCCESS
• subcontractNumber: string
  Example: DA34-019:0010
• subJobNumber: string
  Example: DA-DA34-019
• texturaJobID: number
  Example: 34886500
• totalDuplicate: number
  Example: 0
• totalError: number
  Example: 1
• totalInfo: number
  Example: 0
• totalSuccess: number
  Example: 1
• vendorId: string
  Example: 11020949

{
    "type":"object",
    "properties":{
        "texturaJobID":{
            "type":"number",
            "example":"34886500",
            "nullable":true
        },
        "totalDuplicate":{
            "type":"number",
            "example":"0",
            "nullable":true
        },
        "totalError":{
            "type":"number",
            "example":"1",
            "nullable":true
        },
        "totalInfo":{
            "type":"number",
            "example":"0",
            "nullable":true
        },
        "totalSuccess":{
            "type":"number",
            "example":"1",
            "nullable":true
        },
        "formattedMessage":{
            "type":"string",
            "example":"'Worker's Comp' is set to Received for Arrange Engineering for contract number DA34-019:0010",
            "nullable":true
        },
        "isoDateTime":{
            "type":"string",
            "example":"2023-02-02T12:24:17.215807",
            "nullable":true
        },
        "mainJobNumber":{
            "type":"string",
            "example":"DA-DA34-019",
            "nullable":true
        },
        "newRequirementStatus":{
            "type":"string",
            "example":"Received",
            "nullable":true
        },
        "requirementName":{
            "type":"string",
            "example":"Worker's Comp",
            "nullable":true
        },
        "status":{
            "type":"string",
            "example":"SUCCESS",
            "nullable":true
        },
        "subJobNumber":{
            "type":"string",
            "example":"DA-DA34-019",
            "nullable":true
        },
        "subcontractNumber":{
            "type":"string",
            "example":"DA34-019:0010",
            "nullable":true
        },
        "vendorId":{
            "type":"string",
            "example":"11020949",
            "nullable":true
        }
    }
}

Examples

Select an example Change orders response

202 Response

Accepted. Encountered when the requestor has asked for request export data or an audit log, but the request is still in process.

Default Response

Links to working URLs

Links

Production URL

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

Test URL

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

Back to Top