Jump to

• Request
• Response

View a Workspace Image

get

/api/restapi/workspace/image/{workspaceId}

This endpoint returns workspace images that meet the following requirements:

• The object belongs to a workspace with an ID value that matches the value of the {workspaceId} path parameter.

.

Request

Path Parameters

• workspaceId(required): integer(int64)
  The system-generated identifier of a workspace.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ApiEntityWorkspaceImage

Type: object

Title: ApiEntityWorkspaceImage

Read Only: true

Show Source

• image: array image
  An image object represented in binary format.
• imageType: string
  Allowed Values: [ "PNG", "JPEG", "GIF" ]

  The file type of the image. Valid values are PNG, JPEG, and GIF.
• link: string (url)
  Read Only: true

  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.
• workspaceId: integer (int64)
  The unique identifier of the workspace that contains this image.
• workspaceImageId: integer (int64)
  The unique identifier of the image.

{
    "title":"ApiEntityWorkspaceImage",
    "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",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of the workspace that contains this image.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "image":{
            "type":"array",
            "description":"An image object represented in binary format.",
            "exampleSetFlag":false,
            "items":{
                "type":"string",
                "format":"byte",
                "exampleSetFlag":false,
                "types":[
                    "string"
                ]
            },
            "types":[
                "array"
            ]
        },
        "imageType":{
            "type":"string",
            "description":"The file type of the image. Valid values are <b>PNG</b>, <b>JPEG</b>, and  <b>GIF</b>.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PNG",
                "JPEG",
                "GIF"
            ]
        },
        "workspaceImageId":{
            "type":"integer",
            "description":"The unique identifier of the image.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "readOnly":true,
    "exampleSetFlag":false
}

Nested Schema : image

Type: array

An image object represented in binary format.

Show Source

• Array of: string(byte)

{
    "type":"array",
    "description":"An image object represented in binary format.",
    "exampleSetFlag":false,
    "items":{
        "type":"string",
        "format":"byte",
        "exampleSetFlag":false,
        "types":[
            "string"
        ]
    },
    "types":[
        "array"
    ]
}

204 Response

Successful operation with no content.

404 Response

The requested workspace image data does not exist or you do not have access to it.

Back to Top