Jump to

• Request
• Response

View all Project Companies by Company Name and Postal Code

get

/api/restapi/projectCompany/company/{companyName}/{postalCode}

This endpoint returns project companies that meet the following requirements:

• The object has a name that matches the value of the {companyName} path parameter.
• The object has a code that matches the value of the {postalCode} path parameter.

Request

Path Parameters

• companyName(required): string
  The name of a company.
• postalCode(required): string
  The postal code associated with a company.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : List<ApiEntityProjectCompany>

Type: array

Title: List<ApiEntityProjectCompany>

Show Source

• Array of: object ApiEntityProjectCompany
  Title: ApiEntityProjectCompany

  This entity represents a ProjectCompany object, a unique ProjectCompany object can be identified by the following combinations of the fields.

  • projectCompanyId
  • projectId,companyId
  • companyId,projectCode,workspaceCode
  • companyName,postalCode,projectId
  • companyName,postalCode,projectCode,workspaceCode

{
    "title":"List<ApiEntityProjectCompany>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProjectCompany",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityProjectCompany

Type: object

Title: ApiEntityProjectCompany

This entity represents a ProjectCompany object, a unique ProjectCompany object can be identified by the following combinations of the fields.

• projectCompanyId
• projectId,companyId
• companyId,projectCode,workspaceCode
• companyName,postalCode,projectId
• companyName,postalCode,projectCode,workspaceCode

Show Source

• color: string
  Minimum Length: 1

  Maximum Length: 6

  The selected color representation of the company.
• companyId: integer (int64)
  The unique identifier for the company.The company object can also be identified by its unique criteria.
• companyName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the company.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• postalCode: string
  Minimum Length: 0

  Maximum Length: 20

  The postal code, post code, or zip code of a location.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectCompanyId: integer (int64)
  The system-generated unique identifier of the project company.
• projectId: integer (int64)
  The unique identifier for the project.The project object can also be identified by its unique criteria.
• updateDate: string (date-time)
  Date when the record was last updated.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityProjectCompany",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "companyName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the company.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "postalCode":{
            "maxLength":"20",
            "minLength":"0",
            "type":"string",
            "description":"The postal code, post code, or zip code of a location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectCompanyId":{
            "type":"integer",
            "description":"The system-generated unique identifier of the project company.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "companyId":{
            "type":"integer",
            "description":"The unique identifier for the company.The company object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "color":{
            "maxLength":"6",
            "minLength":"1",
            "type":"string",
            "description":"The selected color representation of the company.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a ProjectCompany object, a unique ProjectCompany object can be identified by the following combinations of the fields.<ul><li>projectCompanyId</li><li>projectId,companyId</li><li>companyId,projectCode,workspaceCode</li><li>companyName,postalCode,projectId</li><li>companyName,postalCode,projectCode,workspaceCode</li>",
    "exampleSetFlag":false
}

204 Response

Successful operation with no content.

400 Response

Invalid input for a baseline company.

404 Response

The requested project company does not exist, or you do not have access to it.

Back to Top