Jump to

• Request
• Response

1a User Roles

post

/api/v1/import/user-project-roles

This API will assign project roles for users based on the project number and email address of the record. If the deactivated parameter is set to true, the API will remove all the roles of the user for that project. The email address must match an existing user in TPM with the appropriate user permissions for that role.

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

• Deactivated: string
  Boolean parameter

  Example: False
• EMail: string
  Email address of TPM

  Example: [e-mail]
• MainJobNumber: string
  Maximum Length: 300

  The project/job this subcontract is written against.

  Example: 24290012
• ProjectRoles: string
  Signer - sets the user as an invoice signer, Authorizer - sets the user as a payment authorizer, Compliance Manager - sets the user as a compliance manager, Project Manager - sets the user as a TPM Project Manager, Invoice Approver - sets the user as an invoice approver

  Example: Signer
• UserName: string
  TPM user name, can be blank if unknown

{
    "type":"object",
    "properties":{
        "MainJobNumber":{
            "type":"string",
            "description":"The project/job this subcontract is written against.",
            "maxLength":300,
            "example":"24290012",
            "nullable":true
        },
        "Deactivated":{
            "type":"string",
            "description":"Boolean parameter",
            "example":"False",
            "nullable":true
        },
        "UserName":{
            "type":"string",
            "description":"TPM user name, can be blank if unknown",
            "nullable":true
        },
        "EMail":{
            "type":"string",
            "description":"Email address of TPM",
            "example":"[e-mail]",
            "nullable":true
        },
        "ProjectRoles":{
            "type":"string",
            "description":"Signer - sets the user as an invoice signer, Authorizer - sets the user as a payment authorizer, Compliance Manager - sets the user as a compliance manager, Project Manager - sets the user as a TPM Project Manager, Invoice Approver - sets the user as an invoice approver",
            "example":"Signer",
            "nullable":true
        }
    }
}

Examples

Select an example Project User Roles

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/user-project-roles/11

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

Examples

Select an example User project roles response User project roles response

Default Response

Links to working URLs

Links

Production URL

https://services.texturacorp.com/ebis/api/v1/import/user-project-roles

Test URL

https://usint1.textura.oraclecloud.com/ebis/api/v1/import/user-project-roles

Back to Top