Create an announcement
post
/fscmRestApi/resources/11.13.18.05/announcements
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AnnouncementId: string
Maximum Length:
18
The unique identifier of the announcement. -
CategoryCode: string
Maximum Length:
20
The category code of the announcement. Valid values are OC and OF. -
CategoryName: string
Maximum Length:
1024
The category name of the announcement. An announcement can be an article, event, insight, or user-defined. -
CroppedImageFile: string
(byte)
A cropped image as displayed in the announcement newsfeed.
-
Description: string
Title:
Content
A short description of the announcement. -
DescriptionClob: string
(byte)
The announcement content that the users can view.
-
ExpireDate: string
(date-time)
The date when the announcement expires.
-
ExpiryDaysFlag: boolean
Maximum Length:
1
The number of days after which the announcement expires. -
ImageFile: string
(byte)
The image for an announcement can be specified as a File, URL, or Predefined. The Predefined option allows selection from a list of predefined images.
-
ImageName: string
Maximum Length:
1024
The file name of the image to be uploaded, if File option is selected to add an image for the announcement. -
ImageURL: string
Maximum Length:
1024
The image URL link, if URL option is selected to add an image for the announcement. -
IsVisible: string
Maximum Length:
1024
The visibility of the announcement. The visibility can be determined using values 'Y', 'N' or an 'EL Expression'. The default value is set to 'Y'. -
ObjectVersionNumber: integer
(int32)
This attribute is currently not used.
-
StartDate: string
(date-time)
The date on which the announcement is created.
-
Subject: string
Maximum Length:
400
The subject of the announcement.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : announcements-item-response
Type:
Show Source
object
-
AnnouncementId: string
Maximum Length:
18
The unique identifier of the announcement. -
CategoryCode: string
Maximum Length:
20
The category code of the announcement. Valid values are OC and OF. -
CategoryName: string
Maximum Length:
1024
The category name of the announcement. An announcement can be an article, event, insight, or user-defined. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the announcement. -
CreationDate: string
(date-time)
Read Only:
true
The date when the announcement was created. -
CroppedImageFile: string
(byte)
A cropped image as displayed in the announcement newsfeed.
-
Description: string
Title:
Content
A short description of the announcement. -
DescriptionClob: string
(byte)
The announcement content that the users can view.
-
ExpireDate: string
(date-time)
The date when the announcement expires.
-
ExpiryDaysFlag: boolean
Maximum Length:
1
The number of days after which the announcement expires. -
ImageFile: string
(byte)
The image for an announcement can be specified as a File, URL, or Predefined. The Predefined option allows selection from a list of predefined images.
-
ImageName: string
Maximum Length:
1024
The file name of the image to be uploaded, if File option is selected to add an image for the announcement. -
ImageURL: string
Maximum Length:
1024
The image URL link, if URL option is selected to add an image for the announcement. -
IsVisible: string
Maximum Length:
1024
The visibility of the announcement. The visibility can be determined using values 'Y', 'N' or an 'EL Expression'. The default value is set to 'Y'. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the announcement was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the announcement. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
This attribute is currently not used. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
This attribute is currently not used.
-
ShowAnnouncement: string
Read Only:
true
Determines whether the announcement is visible or not. The visibility depends on the EL Expression specified on the IsVisible attribute. -
StartDate: string
(date-time)
The date on which the announcement is created.
-
Subject: string
Maximum Length:
400
The subject of the announcement.
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.