View Linked References

get

/api/restapi/entityReference/linkedReferences

Send a request to this endpoint to view all the linked references.

Request

Query Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : List<ApiEntityResource>
Type: array
Title: List<ApiEntityResource>
Show Source
Nested Schema : ApiEntityResource
Type: object
Title: ApiEntityResource
Show Source
  • Minimum Length: 0
    Maximum Length: 200
    The first line of the address of a location.
    This might be the building number and street address.
  • Minimum Length: 0
    Maximum Length: 200
    The second line of the address of a location.
    This might be a neighborhood or town.
  • The name of the user in the application that is also a resource.
  • Allowed Values: [ "OWNED", "INHERITED" ]
    The type of association in the relationship between the resource and the workspace. Possible values are Owned and Inherited.
  • The calendar assigned to the resource or role.
  • Minimum Length: 0
    Maximum Length: 255
    The unique code for the calendar.
  • Minimum Length: 0
    Maximum Length: 255
    The name of the calendar.
  • Minimum Length: 0
    Maximum Length: 200
    The city name for a location.
  • codeValuesResource
    The list of code values for a resource. This entity can only be used to assign codeValues or create codeValues on the fly.
  • Allowed Values: [ "HOUR", "DAY", "WEEK", "MONTH", "YEAR" ]
    The type of costs associated with a resource.
  • Minimum Length: 0
    Maximum Length: 3
    The country for a location.
  • The default unit/time is the maximum work units per time a resource or role can perform on all their assigned activities. The value is shown as either a percentage or units/duration depending on the user settings. If the Resource Type is Material, then units/duration are always displayed.
    For example, if the selected resource is one person, a reasonable value may be 8 hours (units) per day (duration). In this case, the Max Units/Time would be 8.00h/d, or 8 hours of work per day, which is represented as 100%.
  • Minimum Length: 0
    Maximum Length: 4000
    Additional information for the resource or the role.
  • Minimum Length: 0
    Maximum Length: 255
    The email address for the resource.
  • Minimum Length: 0
    Maximum Length: 60
    The resource identifier within the organization, typically the employee number or social security number.
  • Minimum Value: -90
    Maximum Value: 90
    The geographical coordinate for the latitude of the location.
    The default format for latitude is decimal degrees format, but the format you need to use will depend on your geolocation service.
  • Minimum Value: -180
    Maximum Value: 180
    The geographical coordinate for the longitude of the location.
    The default format for longitude is decimal degrees format, but the format you need to use will depend on your geolocation service.
  • Minimum Length: 0
    Maximum Length: 32
    The office phone number for the resource.
  • Minimum Length: 0
    Maximum Length: 32
    The alternate phone numbers for the resource.
  • The overtime factor used to compute the overtime price for the resource.
  • The unique identifier for the parent resource or role.
  • Minimum Length: 1
    Maximum Length: 60
    The parent resource code of a resource.
  • Minimum Length: 0
    Maximum Length: 20
    The postal code, post code, or zip code of a location.
  • Allowed Values: [ "OWNED", "INHERITED" ]
    The type of association in the relationship between the resource and the project. Possible values are Owned and Inherited.
  • Maximum Length: 60
    The unique identifier for a project set by the user who created the project.
  • The unique identifier for the project.
  • Allowed Values: [ "RESOURCE", "ROLE" ]
    The class identifies the item as a resource or a role.
  • Minimum Length: 1
    Maximum Length: 60
    The unique identifier for the resource or role.
  • The unique identifier for the resource or role.
  • The person designated as the manager for the resource.
  • Minimum Length: 1
    Maximum Length: 255
    The name of the resource or role.
  • Allowed Values: [ "WORKSPACE", "PROJECT" ]
    The type of ownership for a resource. Possible values include Workspace and Project.
  • The identifier for the role assigned to the resource.
  • Allowed Values: [ "ACTIVE", "INACTIVE" ]
    Determines whether the resource or role is currently active.
    Inactive resources might have left the organization, but are not deleted from the system because they might have been assigned an activity in the past or have incurred actual hours.
  • Minimum Length: 0
    Maximum Length: 255
    The job title for the resource.
    For example, a resource may have the title Senior Engineer.
  • Allowed Values: [ "LABOR", "NONLABOR", "MATERIAL" ]
    The resource type. Valid values are:
    Labor: Indicates that the selected resource performs labor, measured in units of time.
    Nonlabor: Indicates that the selected resource does not perform labor, measured in units of time. Equipment is a nonlabor resource.
    Material: Indicates that the resource has a unit of measure other than time. You can select a unit of measure for the material resource.
  • Maximum Length: 255
    The unique identifier of resource data in an external source.
  • Minimum Length: 0
    Maximum Length: 2
    A unique identifier for the state or province.
  • Minimum Length: 0
    Maximum Length: 200
    The state, region, or province of a location.
  • Minimum Length: 0
    Maximum Length: 60
    The abbreviation for the unit of measure name.
  • The unit of measure used for the material resource.
  • Date when the record was last updated.
  • Minimum Length: 0
    Maximum Length: 60
    The user-specified identifier of a workspace.
  • The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.
  • Minimum Length: 1
    Maximum Length: 255
    Name of a workspace.
Nested Schema : codeValuesResource
Type: array
The list of code values for a resource. This entity can only be used to assign codeValues or create codeValues on the fly.
Show Source
Nested Schema : ApiEntityCodeValueResource
Type: object
Title: ApiEntityCodeValueResource
Show Source

204 Response

Successful operation with no content.

404 Response

The requested reference does not exist, or you do not have access to it.
Back to Top