Update an image
patch
/fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/images/{ImageId}
Request
Path Parameters
-
ImageId(required): integer(int64)
The unique identifier for image.
-
PartyId(required): integer(int64)
The unique identifier for the party. Party can be a person. For example, a student can be a party.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ImageContent: string
(byte)
Title:
Attachment Content
The binary representation of the attachment. -
ImageName: string
Maximum Length:
240
The name of the image.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : personProfiles-images-item-response
Type:
Show Source
object
-
ImageContent: string
(byte)
Title:
Attachment Content
The binary representation of the attachment. -
ImageId: integer
(int64)
Title:
Attachment ID
Read Only:true
The unique identifier for image. -
ImageName: string
Maximum Length:
240
The name of the image. -
ImageTypeCode: string
Title:
Attachment Type Code
Read Only:true
Maximum Length:30
Default Value:PROFILE_PHOTO
The type code of the attachment, for example, STUDENT_PHOTO and INSTRUCTOR_PHOTO. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.