Jump to

• Request
• Response

View all Related Items of a Reference

get

/api/restapi/entityReference/relatedItems

Send a request to this endpoint to view all the related items of a reference.

Request

Query Parameters

• programCode: string
  The user-specified unique identifier of a program.
• projectCode(required): string
  The user-specified identifier of a project.
  This is a required field.
• recordCode(required): string
  The user-specified identifier of an object associated with a reference.
  This is a required field.
• recordId(required): integer(int64)
  The system-generated identifier of an object associated with a reference.
  This is a required field.
• recordType(required): string
  The type of an object that supports references.
  This is a required field.

  Allowed Values: [ "ACTIVITY", "IDEA", "PROJECT", "PROG_RISK", "RISK", "WORK_MANAGER_TASK" ]
• workspaceCode(required): string
  The user-specified identifier of a workspace.
  This is a required field.

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<ApiEntityEntityReference>

Type: array

Title: List<ApiEntityEntityReference>

Show Source

• Array of: object ApiEntityEntityReference
  Title: ApiEntityEntityReference

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

Nested Schema : ApiEntityEntityReference

Type: object

Title: ApiEntityEntityReference

Show Source

• entityReferenceId: integer (int64)
  The system-generated identifier of a reference.
• fromId: integer (int64)
  The system-generated identifier of the object the reference is from.
• fromType: string
  Allowed Values: [ "ACTIVITY", "IDEA", "PROJECT", "PROG_RISK", "RISK", "WORK_MANAGER_TASK" ]

  The type of the object the reference is from.
• fromTypeRecordCode: string
  The user-specified identifier of an object associated with a reference.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• programCode: string
  The user-specified unique identifier of a program.
• projectCode: string
  The user-specified identifier of a project.
• toId: integer (int64)
  The system-generated identifier of the object a reference is a reference to.
• toType: string
  Allowed Values: [ "ACTIVITY", "IDEA", "PROJECT", "PROG_RISK", "RISK", "WORK_MANAGER_TASK" ]

  The type of the object a reference refers to.
• toTypeRecordCode: string
  The user-specified identifier of an object associated with a reference.
• updateDate: string (date-time)
  Date when the record was last updated.
• workspaceCode: string
  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityEntityReference",
    "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"
            ]
        },
        "entityReferenceId":{
            "type":"integer",
            "description":"The system-generated identifier of a reference.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "fromType":{
            "type":"string",
            "description":"The type of the object the reference is from.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "ACTIVITY",
                "IDEA",
                "PROJECT",
                "PROG_RISK",
                "RISK",
                "WORK_MANAGER_TASK"
            ]
        },
        "toId":{
            "type":"integer",
            "description":"The system-generated identifier of the object a reference is a reference to.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "toType":{
            "type":"string",
            "description":"The type of the object a reference refers to.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "ACTIVITY",
                "IDEA",
                "PROJECT",
                "PROG_RISK",
                "RISK",
                "WORK_MANAGER_TASK"
            ]
        },
        "fromId":{
            "type":"integer",
            "description":"The system-generated identifier of the object the reference is from.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "fromTypeRecordCode":{
            "type":"string",
            "description":"The user-specified identifier of an object associated with a reference.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "toTypeRecordCode":{
            "type":"string",
            "description":"The user-specified identifier of an object associated with a reference.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectCode":{
            "type":"string",
            "description":"The user-specified identifier of a project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programCode":{
            "type":"string",
            "description":"The user-specified unique identifier of a program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

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