Jump to

• Request
• Response

Batch Create Capital Portfolio Members

post

/api/restapi/capitalPortfolioMember/batch

Send a request to this endpoint to create one or more capital portfolio members. 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<ApiEntityCapitalPortfolioMemberInput>

Type: array

Title: List<ApiEntityCapitalPortfolioMemberInput>

Show Source

• Array of: object ApiEntityCapitalPortfolioMemberInput
  Title: ApiEntityCapitalPortfolioMemberInput

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

  • portfolioId
  • name,workspaceId
  • name,workspaceCode

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

Nested Schema : ApiEntityCapitalPortfolioMemberInput

Type: object

Title: ApiEntityCapitalPortfolioMemberInput

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

• portfolioId
• name,workspaceId
• name,workspaceCode

Show Source

• capitalPortfolioId(required): integer (int64)
  The unique identifier of a portfolio.
• capitalPortfolioMemberId: integer (int64)
  The unique identifier of a portfolio member.
• capitalPortfolioName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of a portfolio.
• link: string (url)
  Read Only: true

  Deprecated. As of 24.5.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• memberPortfolioId(required): integer (int64)
  The unique identifier of a portfolio associated to a portfolio member.
• memberPortfolioName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of a portfolio associated to a portfolio member.
• memberPortfolioWorkspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.
• memberPortfolioWorkspaceId: integer (int64)
  The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 24.5.
  Date when the record was last updated.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The code of the workspace associated to a portfolio member.
• workspaceId: integer (int64)
  The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.

{
    "title":"ApiEntityCapitalPortfolioMemberInput",
    "required":[
        "capitalPortfolioId",
        "memberPortfolioId"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.5</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"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.5</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The code of the workspace associated to a portfolio member.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "capitalPortfolioId":{
            "type":"integer",
            "description":"The unique identifier of a portfolio.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "memberPortfolioId":{
            "type":"integer",
            "description":"The unique identifier of a portfolio associated to a portfolio member.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "memberPortfolioWorkspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "memberPortfolioWorkspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "memberPortfolioName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of a portfolio associated to a portfolio member.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "capitalPortfolioMemberId":{
            "type":"integer",
            "description":"The unique identifier of a portfolio member.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "capitalPortfolioName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of a portfolio.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a CapitalPortfolioMember object, a unique CapitalPortfolioMember object can be identified by the following combinations of the fields.<ul><li>portfolioId</li><li>name,workspaceId</li><li>name,workspaceCode</li>",
    "exampleSetFlag":false
}

Examples

Select an example Batch Create Capital Portfolio Members

Back to Top

Response

Supported Media Types

• application/json

201 Response

The object was successfully created.

Body ()

Root Schema : List<ApiEntityCapitalPortfolioMember>

Type: array

Title: List<ApiEntityCapitalPortfolioMember>

Show Source

• Array of: object ApiEntityCapitalPortfolioMember
  Title: ApiEntityCapitalPortfolioMember

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

Nested Schema : ApiEntityCapitalPortfolioMember

Type: object

Title: ApiEntityCapitalPortfolioMember

Show Source

• capitalPortfolioId: integer (int64)
  The unique identifier of a portfolio.
• capitalPortfolioMemberId: integer (int64)
  The unique identifier of a portfolio member.
• capitalPortfolioName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of a portfolio.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• memberPortfolioId: integer (int64)
  The unique identifier of a portfolio associated to a portfolio member.
• memberPortfolioName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of a portfolio associated to a portfolio member.
• memberPortfolioWorkspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.
• memberPortfolioWorkspaceId: integer (int64)
  The unique identifier for the workspace.The workspace 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 code of the workspace associated to a portfolio member.
• workspaceId: integer (int64)
  The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.

{
    "title":"ApiEntityCapitalPortfolioMember",
    "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"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The code of the workspace associated to a portfolio member.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "capitalPortfolioId":{
            "type":"integer",
            "description":"The unique identifier of a portfolio.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "memberPortfolioId":{
            "type":"integer",
            "description":"The unique identifier of a portfolio associated to a portfolio member.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "memberPortfolioWorkspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "memberPortfolioWorkspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "memberPortfolioName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of a portfolio associated to a portfolio member.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "capitalPortfolioMemberId":{
            "type":"integer",
            "description":"The unique identifier of a portfolio member.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "capitalPortfolioName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of a portfolio.",
            "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 for the capital portfolio member service.

Back to Top