Jump to

• Request
• Response

View a Project Image

get

/api/restapi/project/image/{projectId}

This endpoint returns project images that meet the following requirements:

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

Request

Path Parameters

• projectId(required): integer(int64)
  The system-generated identifier of a project.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ApiEntityProjectImage

Type: object

Title: ApiEntityProjectImage

Show Source

• image: array image
  The image file uploaded to the project.
  Displayed throughout the application in areas like news feeds.
• imageType: string
  Allowed Values: [ "PNG", "JPEG", "GIF" ]

  The mime type of an image associated with a project.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• project: integer (int64)
  The system-generated identifier of a project.
• projectImageId: integer (int64)
  The system-generated identifier of a project image. This value should not be provided in create operation request data, however, it is required for update requests.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityProjectImage",
    "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"
            ]
        },
        "project":{
            "type":"integer",
            "description":"The system-generated identifier of a project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "image":{
            "type":"array",
            "description":"The image file uploaded to the project. <br />Displayed throughout the application in areas like news feeds.",
            "exampleSetFlag":false,
            "items":{
                "type":"string",
                "format":"byte",
                "exampleSetFlag":false,
                "types":[
                    "string"
                ]
            },
            "types":[
                "array"
            ]
        },
        "imageType":{
            "type":"string",
            "description":"The mime type of an image associated with a project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PNG",
                "JPEG",
                "GIF"
            ]
        },
        "projectImageId":{
            "type":"integer",
            "description":"The system-generated identifier of a project image. This value should not be provided in create operation request data, however, it is required for update requests.",
            "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 file uploaded to the project.
Displayed throughout the application in areas like news feeds.

Show Source

• Array of: string(byte)

{
    "type":"array",
    "description":"The image file uploaded to the project. <br />Displayed throughout the application in areas like news feeds.",
    "exampleSetFlag":false,
    "items":{
        "type":"string",
        "format":"byte",
        "exampleSetFlag":false,
        "types":[
            "string"
        ]
    },
    "types":[
        "array"
    ]
}

204 Response

Successful operation with no content.

404 Response

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

Back to Top