Jump to

• Request
• Response

Batch Create References

post

/api/restapi/entityReference/batch

Send a request to this endpoint to create one or more references. An application object will be created for each JSON object provided in the request body.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : List<ApiEntityEntityReferenceInput>

Type: array

Title: List<ApiEntityEntityReferenceInput>

Show Source

• Array of: object ApiEntityEntityReferenceInput
  Title: ApiEntityEntityReferenceInput

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

Nested Schema : ApiEntityEntityReferenceInput

Type: object

Title: ApiEntityEntityReferenceInput

Show Source

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

  The type of the object the reference is from.
• fromTypeRecordCode: string
  Maximum Length: 60

  The user-specified identifier of an object associated with a reference.
• link: string (url)
  Read Only: true

  Deprecated. As of 24.4.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• programCode(required): string
  Maximum Length: 60

  The user-specified unique identifier of a program.
• projectCode(required): string
  Maximum Length: 60

  The user-specified identifier of a project.
• toId(required): integer (int64)
  The system-generated identifier of the object a reference is a reference to.
• toType(required): string
  Allowed Values: [ "ACTIVITY", "IDEA", "PROJECT", "PROG_RISK", "RISK", "WORK_MANAGER_TASK" ]

  The type of the object a reference refers to.
• toTypeRecordCode: string
  Maximum Length: 60

  The user-specified identifier of an object associated with a reference.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 24.4.
  Date when the record was last updated.
• workspaceCode(required): string
  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityEntityReferenceInput",
    "required":[
        "fromId",
        "fromType",
        "programCode",
        "projectCode",
        "toId",
        "toType",
        "workspaceCode"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.4</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "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":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of an object associated with a reference.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "toTypeRecordCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of an object associated with a reference.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.4</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "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":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified unique identifier of a program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Examples

Select an example Batch Create References

Back to Top

Response

Supported Media Types

• application/json

201 Response

The object was successfully created.

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
}

400 Response

Invalid Input.

Back to Top