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.

There are two ways to assign project roles for a user. The first is the use of the legacy parameter, ProjectRoles. Providing a list of roles to the ProjectRoles parameter, will assign those project roles to the user, provided they have the appropriate user permissions. The second way of assignment is to provide the role and role status to ProjectRolesList. For the ProjectRolesList, the role status is denoted by 'enabled' or 'disabled'.

ProjectRoles can assign the roles of Project Manager, Compliance Manager, Invoice Approver, Signer, and Authorizer. ProjectRolesList can assign all the roles that ProjectRoles can assign and also the roles of Disburser and Owner Funding Manager.

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

• Deactivated(required): string
  Boolean parameter to denote user status for a specific project.

  Example: False
• Email(required): string
  Email address of TPM user.

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

  The project for which this user will be created or modified for.

  Example: 24290012
• ProjectRoles(required): string
  This is a legacy parameter. This parameter will take a list of roles and assign those roles to the user, for the project, if the user has appropriate permissions. 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, Invoice Approver]
• ProjectRolesList: string
  A parameter that allows the user roles to be either deactivated or activated for a project. A user can express role status by declaring the role and the stating the values of enabled or disabled. This parameter covers all roles similar to ProjectRoles and includes the roles of Disburser and Owner Funding Manager.

  Example: {'Signer': 'enabled', 'Invoice Approver': 'disabled'}
• UserName: string
  TPM user name, if blank then the e-mail parameter will retriever user info.

{
    "required":[
        "MainJobNumber",
        "Deactivated",
        "Email",
        "ProjectRoles"
    ],
    "type":"object",
    "properties":{
        "MainJobNumber":{
            "type":"string",
            "description":"The project for which this user will be created or modified for.",
            "maxLength":"300",
            "example":"24290012",
            "nullable":true
        },
        "Deactivated":{
            "type":"string",
            "description":"Boolean parameter to denote user status for a specific project.",
            "example":"False",
            "nullable":true
        },
        "UserName":{
            "type":"string",
            "description":"TPM user name, if blank then  the e-mail parameter will retriever user info.",
            "nullable":true
        },
        "Email":{
            "type":"string",
            "description":"Email address of TPM user.",
            "example":"[e-mail]",
            "nullable":true
        },
        "ProjectRoles":{
            "type":"string",
            "description":"This is a legacy parameter. This parameter will take a list of roles and assign those roles to the user, for the project, if the user has appropriate permissions. 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, Invoice Approver]",
            "nullable":true
        },
        "ProjectRolesList":{
            "type":"string",
            "description":"A parameter that allows the user roles to be either deactivated or activated for a project. A user can express role status by declaring the role and the stating the values of enabled or disabled. This parameter covers all roles similar to ProjectRoles and includes the roles of Disburser and Owner Funding Manager.",
            "example":"{'Signer': 'enabled', 'Invoice Approver': 'disabled'}",
            "nullable":true
        }
    }
}

Examples

Select an example Import project user roles request 1 Import project user roles request 2

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 Production Server: Import user project roles response Test Server: Import 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