機械翻訳について

ジャンプ先

• リクエスト
• レスポンス

お知らせの作成

post

/fscmRestApi/resources/11.13.18.05/announcements

リクエスト

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプは実行時に変わる可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーがAPIのデフォルト・バージョンを選択します。
• Upsert-Mode:
  次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は有効日RESTリソースではサポートされていません。

サポートされているメディア・タイプ

• application/json

リクエスト本文 - application/json ()

ルート・スキーマ : schema

タイプ: object

Show Source

• AnnouncementId: string
  最大長: 18

  お知らせの一意の識別子。
• CategoryCode: string
  最大長: 20

  お知らせのカテゴリ・コード。 有効な値はOCおよびOFです。
• CategoryName: string
  最大長: 1024

  お知らせのカテゴリ名。 お知らせには、記事、イベント、インサイトまたはユーザー定義があります。
• CroppedImageFile: string (byte)
  お知らせニュース・フィードに表示されるクロップされたイメージ。
• 摘要: string
  タイトル: Content

  お知らせの簡単な説明。
• DescriptionClob: string (byte)
  ユーザーが表示できるお知らせコンテンツ。
• ExpireDate: string (date-time)
  お知らせが失効する日付。
• ExpiryDaysFlag: boolean
  最大長: 1

  お知らせが期限切れになるまでの日数。
• ImageFile: string (byte)
  お知らせのイメージは、ファイル、URLまたは事前定義済として指定できます。 「事前定義済」オプションを使用すると、事前定義されたイメージのリストから選択できます。
• ImageName: string
  最大長: 1024

  お知らせのイメージを追加するためにファイル・オプションが選択されている場合、アップロードするイメージのファイル名。
• ImageURL: string
  最大長: 1024

  お知らせのイメージを追加するためのURLオプションが選択されている場合、イメージURLリンク。
• IsVisible: string
  最大長: 1024

  お知らせの表示。 可視性は、値'Y'、'N'または'EL式'を使用して決定できます。 デフォルト値は'Y'に設定されます。
• ObjectVersionNumber: integer (int32)
  この属性は現在使用されていません。
• StartDate: string (date-time)
  お知らせが作成された日付。
• 件名: string
  最大長: 400

  お知らせの件名。

{
    "type":"object",
    "properties":{
        "CategoryCode":{
            "maxLength":20,
            "type":"string",
            "description":"The category code of the announcement. Valid values are OC and OF.",
            "nullable":false
        },
        "AnnouncementId":{
            "maxLength":18,
            "type":"string",
            "description":"The unique identifier of the announcement.",
            "nullable":false
        },
        "Description":{
            "title":"Content",
            "type":"string",
            "description":"A short description of the announcement.",
            "nullable":true
        },
        "ImageFile":{
            "type":"string",
            "description":"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.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ExpireDate":{
            "type":"string",
            "description":"The date when the announcement expires.",
            "format":"date-time",
            "nullable":true
        },
        "ImageURL":{
            "maxLength":1024,
            "type":"string",
            "description":"The image URL link, if URL option is selected to add an image for the announcement.",
            "nullable":true
        },
        "Subject":{
            "maxLength":400,
            "type":"string",
            "description":"The subject of the announcement.",
            "nullable":false
        },
        "CroppedImageFile":{
            "type":"string",
            "description":"A cropped image as displayed in the announcement newsfeed.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "StartDate":{
            "type":"string",
            "description":"The date on which the announcement is created.",
            "format":"date-time",
            "nullable":false
        },
        "ImageName":{
            "maxLength":1024,
            "type":"string",
            "description":"The file name of the image to be uploaded, if File option is selected to add an image for the announcement.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"This attribute is currently not used.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "DescriptionClob":{
            "type":"string",
            "description":"The announcement content that the users can view.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ExpiryDaysFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The number of days after which the announcement expires.",
            "nullable":true
        },
        "CategoryName":{
            "maxLength":1024,
            "type":"string",
            "description":"The category name of the announcement. An announcement can be an article, event, insight, or user-defined.",
            "nullable":true
        },
        "IsVisible":{
            "maxLength":1024,
            "type":"string",
            "description":"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'.",
            "nullable":true
        }
    }
}

トップに戻る

レスポンス

サポートされているメディア・タイプ

• application/json

デフォルト・レスポンス

次の表に、このタスクのデフォルト・レスポンスを示します。

Headers

• Metadata-Context(required):
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプは実行時に変わる可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーがAPIのデフォルト・バージョンを選択します。

本文 ()

ルート・スキーマ : announcements-item-response

タイプ: object

Show Source

• AnnouncementId: string
  最大長: 18

  お知らせの一意の識別子。
• CategoryCode: string
  最大長: 20

  お知らせのカテゴリ・コード。 有効な値はOCおよびOFです。
• CategoryName: string
  最大長: 1024

  お知らせのカテゴリ名。 お知らせには、記事、イベント、インサイトまたはユーザー定義があります。
• CreatedBy: string
  読取り専用: true

  最大長: 64

  お知らせを作成したユーザー。
• CreationDate: string (date-time)
  読取り専用: true

  お知らせが作成された日付。
• CroppedImageFile: string (byte)
  お知らせニュース・フィードに表示されるクロップされたイメージ。
• 摘要: string
  タイトル: Content

  お知らせの簡単な説明。
• DescriptionClob: string (byte)
  ユーザーが表示できるお知らせコンテンツ。
• ExpireDate: string (date-time)
  お知らせが失効する日付。
• ExpiryDaysFlag: boolean
  最大長: 1

  お知らせが期限切れになるまでの日数。
• ImageFile: string (byte)
  お知らせのイメージは、ファイル、URLまたは事前定義済として指定できます。 「事前定義済」オプションを使用すると、事前定義されたイメージのリストから選択できます。
• ImageName: string
  最大長: 1024

  お知らせのイメージを追加するためにファイル・オプションが選択されている場合、アップロードするイメージのファイル名。
• ImageURL: string
  最大長: 1024

  お知らせのイメージを追加するためのURLオプションが選択されている場合、イメージURLリンク。
• IsVisible: string
  最大長: 1024

  お知らせの表示。 可視性は、値'Y'、'N'または'EL式'を使用して決定できます。 デフォルト値は'Y'に設定されます。
• LastUpdateDate: string (date-time)
  読取り専用: true

  お知らせの最終更新日。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  お知らせを最後に更新したユーザー。
• LastUpdateLogin: string
  読取り専用: true

  最大長: 32

  この属性は現在使用されていません。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられているリンクの関係。
• ObjectVersionNumber: integer (int32)
  この属性は現在使用されていません。
• ShowAnnouncement: string
  読取り専用: true

  お知らせを表示するかどうかを決定します。 可視性は、IsVisible属性で指定されたEL式によって異なります。
• StartDate: string (date-time)
  お知らせが作成された日付。
• 件名: string
  最大長: 400

  お知らせの件名。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the announcement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ShowAnnouncement":{
            "type":"string",
            "description":"Determines whether the announcement is visible or not. The visibility depends on the EL Expression specified on the IsVisible attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryCode":{
            "maxLength":20,
            "type":"string",
            "description":"The category code of the announcement. Valid values are OC and OF.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the announcement was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AnnouncementId":{
            "maxLength":18,
            "type":"string",
            "description":"The unique identifier of the announcement.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the announcement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Content",
            "type":"string",
            "description":"A short description of the announcement.",
            "nullable":true,
            "x-queryable":true
        },
        "ImageFile":{
            "type":"string",
            "description":"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.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ExpireDate":{
            "type":"string",
            "description":"The date when the announcement expires.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ImageURL":{
            "maxLength":1024,
            "type":"string",
            "description":"The image URL link, if URL option is selected to add an image for the announcement.",
            "nullable":true,
            "x-queryable":true
        },
        "Subject":{
            "maxLength":400,
            "type":"string",
            "description":"The subject of the announcement.",
            "nullable":false,
            "x-queryable":true
        },
        "CroppedImageFile":{
            "type":"string",
            "description":"A cropped image as displayed in the announcement newsfeed.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "StartDate":{
            "type":"string",
            "description":"The date on which the announcement is created.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "ImageName":{
            "maxLength":1024,
            "type":"string",
            "description":"The file name of the image to be uploaded, if File option is selected to add an image for the announcement.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"This attribute is currently not used.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "DescriptionClob":{
            "type":"string",
            "description":"The announcement content that the users can view.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ExpiryDaysFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The number of days after which the announcement expires.",
            "nullable":true,
            "x-queryable":true
        },
        "CategoryName":{
            "maxLength":1024,
            "type":"string",
            "description":"The category name of the announcement. An announcement can be an article, event, insight, or user-defined.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "IsVisible":{
            "maxLength":1024,
            "type":"string",
            "description":"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'.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the announcement was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"This attribute is currently not used.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられているリンクの関係。

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : リンク

タイプ: object

Show Source

• href: string
  タイトル: hyperlink reference

  関連付けられたリソースへのURI。
• kind: string
  タイトル: kind

  許可された値: [ "collection", "item", "describe", "other" ]

  関連付けられたリソースの種類。
• name: string
  タイトル: name

  関連付けられたリソースへのリンクの名前。
• properties: object properties
• rel: string
  タイトル: relation

  許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  リソース・インスタンスとの関係の名前。 例: self.

{
    "type":"object",
    "properties":{
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

ネストされたスキーマ : プロパティ

タイプ: object

Show Source

• changeIndicator: string
  リソース・インスタンスの変更インジケータまたはETagの値。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

「トップに戻る」