PUT Project/{id}/ImageInfo
Some tooltip text!
• 5 minutes to read
• 5 minutes to read
PUT /api/v1/Project/{id}/ImageInfo
Update the Blob that describes the given project's picture.
The actual bitmap is accessible via /api/Services80/project/123/image/content.
| Path Part | Type | Description |
|---|---|---|
| id | string | Required |
Query String Parameters
| Parameter Name | Type | Description |
|---|---|---|
| projectId | int32 | Required Project id |
PUT /api/v1/Project/{id}/ImageInfo?projectId=640
Request Headers
| Parameter Name | Description |
|---|---|
| Authorization | Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type. |
| X-XSRF-TOKEN | If not using Authorization header, you must provide XSRF value from cookie or hidden input field |
| Content-Type | Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json |
| Accept | Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json |
| Accept-Language | Convert string references and multi-language values into a specified language (iso2) code. |
| SO-Language | Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value. |
| SO-Culture | Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set. |
| SO-TimeZone | Specify the timezone code that you would like date/time responses converted to. |
| SO-AppToken | The application token that identifies the partner app. Used when calling Online WebAPI from a server. |
Request Body: imageInfo
New or Updated information about the image.
| Property Name | Type | Description |
|---|---|---|
| BlobId | Integer | Primary key |
| BlobSize | Integer | The length, in bytes, of the binary data AS STORED after any encryption and/or zipping. Important to get right, since some databases will not tell us just based on the blob itself! |
| Description | String | A description that is entered by the user, and visible to the user |
| ExtraInfo | String | Extra information, spare field, can be used for anything that makes sense. Should not refer to any particular context, that is something for the BinaryObjectLInk |
| IsEncrypted | Boolean | Has the data been encrypted. |
| IsZipped | Boolean | Has the data been zipped. |
| MimeType | String | Mime type, describing the technical type (image/jpeg) of the data |
| OriginalSize | Integer | Original size of the binary data, before encryption and/or zipping. This is what the ultimate client will get |
| CreatedDate | String | Registered when in UTC. |
| UpdatedDate | String | Last updated when in UTC. |
| CreatedBy | Associate | The person that first created the document. The property is read-only. |
| UpdatedBy | Associate | The person that last updated the appointment. |
| ConceptualType | String | The type, for instance PHOTO, PERSONPHOTO, or whatever, that is descriptive of what kind of image or data this is |
Response:
OK
| Response | Description |
|---|---|
| 200 | OK |
| 400 | Bad request. Entity to save is not in request body. |
Response body: BlobEntity
| Property Name | Type | Description |
|---|---|---|
| BlobId | int32 | Primary key |
| BlobSize | int32 | The length, in bytes, of the binary data AS STORED after any encryption and/or zipping. Important to get right, since some databases will not tell us just based on the blob itself! |
| Description | string | A description that is entered by the user, and visible to the user |
| ExtraInfo | string | Extra information, spare field, can be used for anything that makes sense. Should not refer to any particular context, that is something for the BinaryObjectLInk |
| IsEncrypted | bool | Has the data been encrypted. |
| IsZipped | bool | Has the data been zipped. |
| MimeType | string | Mime type, describing the technical type (image/jpeg) of the data |
| OriginalSize | int32 | Original size of the binary data, before encryption and/or zipping. This is what the ultimate client will get |
| CreatedDate | date-time | Registered when in UTC. |
| UpdatedDate | date-time | Last updated when in UTC. |
| CreatedBy | Associate | The person that first created the document. The property is read-only. |
| UpdatedBy | Associate | The person that last updated the appointment. |
| ConceptualType | string | The type, for instance PHOTO, PERSONPHOTO, or whatever, that is descriptive of what kind of image or data this is |
| TableRight | TableRight | The carrier's table right |
| FieldProperties | object | Field property dictionary mapping field names to field access rights. |
Sample request
PUT /api/v1/Project/{id}/ImageInfo
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Content-Type: application/json; charset=utf-8
{
"BlobId": 139,
"BlobSize": 630,
"Description": "Enterprise-wide reciprocal flexibility",
"ExtraInfo": "est",
"IsEncrypted": false,
"IsZipped": true,
"MimeType": "et",
"OriginalSize": 207,
"CreatedDate": "2015-05-26T04:02:06.7441349+02:00",
"UpdatedDate": "2003-06-08T04:02:06.7441349+02:00",
"CreatedBy": null,
"UpdatedBy": null,
"ConceptualType": "iure"
}
Sample response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"BlobId": 17,
"BlobSize": 627,
"Description": "Team-oriented eco-centric functionalities",
"ExtraInfo": "dignissimos",
"IsEncrypted": false,
"IsZipped": false,
"MimeType": "quis",
"OriginalSize": 956,
"CreatedDate": "2008-06-16T04:02:06.7441349+02:00",
"UpdatedDate": "2020-07-02T04:02:06.7441349+02:00",
"CreatedBy": null,
"UpdatedBy": null,
"ConceptualType": "ducimus",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.String",
"FieldLength": 57
}
}
}