Jump to

• Request
• Response

View a Portfolio Image

get

/api/restapi/portfolio/image/{portfolioId}

This endpoint returns portfolio images that meet the following requirements:

• The object is associated with a portfolio with an ID value that matches the value of the {portfolioId} path parameter.

Request

Path Parameters

• portfolioId(required): integer(int64)
  The system-generated identifier of a portfolio.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ApiEntityPortfolioImage

Type: object

Title: ApiEntityPortfolioImage

Show Source

• image: array image
  The image that represents the portfolio.
• imageType: string
  Allowed Values: [ "PNG", "JPEG", "GIF" ]

  The mime type of an image associated with 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.
• portfolio(required): integer (int64)
  Unique identifier of the portfolio.
• portfolioImageId: integer (int64)
  Unique identifier of the portfolio image.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityPortfolioImage",
    "required":[
        "portfolio"
    ],
    "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"
            ]
        },
        "image":{
            "type":"array",
            "description":"The image that represents the portfolio.",
            "exampleSetFlag":false,
            "items":{
                "type":"string",
                "format":"byte",
                "exampleSetFlag":false,
                "types":[
                    "string"
                ]
            },
            "types":[
                "array"
            ]
        },
        "portfolioImageId":{
            "type":"integer",
            "description":"Unique identifier of the portfolio image.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "imageType":{
            "type":"string",
            "description":"The mime type of an image associated with a portfolio.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PNG",
                "JPEG",
                "GIF"
            ]
        },
        "portfolio":{
            "type":"integer",
            "description":"Unique identifier of the portfolio.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : image

Type: array

The image that represents the portfolio.

Show Source

• Array of: string(byte)

{
    "type":"array",
    "description":"The image that represents the portfolio.",
    "exampleSetFlag":false,
    "items":{
        "type":"string",
        "format":"byte",
        "exampleSetFlag":false,
        "types":[
            "string"
        ]
    },
    "types":[
        "array"
    ]
}

204 Response

Successful operation with no content.

404 Response

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

Back to Top