機械翻訳について

ジャンプ先

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

すべてのコンプライアンス・チェックリスト・テンプレート・レコードの取得

get

/fscmRestApi/resources/11.13.18.05/complianceChecklistTemplates

リクエスト

問合せパラメータ

• effectiveDate: string
  この問合せパラメータは、指定した開始日時点で有効なリソースをフェッチするために使用されます。 この問合せパラメータの値は、yyyy-MM-dd形式の日付を持つ文字列です
• expand: string
  このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees、Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
• fields: string
  このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。
  
  フォーマット : ?fields=Attribute1,Attribute2
  
  子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  コレクションを検索するための事前定義済ファインダとして使用されます。
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  使用可能なファインダ名および対応するファインダ変数を次に示します
  
  

  • FindActiveTemplatesByPrcBuId調達ビジネス・ユニットでアクティブなチェックリスト・テンプレート・レコードを検索します。
    ファインダ変数
    • BindProcurementBuId; integer; 調達ビジネス・ユニットを一意に識別する値です。
  • PrimaryKey指定した主キーに従ってチェックリスト・テンプレート・レコードを検索します。
    ファインダ変数
    • ChecklistTemplateId; integer; チェックリスト・テンプレートを一意に識別する値。
• limit: integer
  このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
• links: string
  このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
  
  例:
  self,canonical
  
• offset: integer
  リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
• onlyData: boolean
  データのみを含めるために(リンク・セクションなしなど)、リソース品目ペイロードがフィルタ処理されます。
• orderBy: string
  このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:desc
• q: string
  この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;事業所=NY
  
  フォーマット : ?q=expression1;expression2
  
  次の問合せ可能な属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
  

  • ChecklistTemplate; string; チェックリスト・テンプレートの名前。
  • ChecklistTemplateDescription; string; チェックリスト・テンプレートの説明。
  • ChecklistTemplateId; integer; チェックリスト・テンプレートのシステム識別子。 この識別子は、資格モデルIDとして格納されます。
  • GlobalFlag; boolean; チェックリスト・テンプレートをすべての調達ビジネス・ユニットで使用できるかどうかを指定します。
  • HasInactiveOrOutdatedComponentsFlag; boolean; チェックリスト・テンプレートに、チェックリスト・セクションまたは質問の非アクティブまたは以前のリビジョンが含まれているかどうかを指定します。
  • LatestRevisionFlag; boolean; チェックリスト・テンプレートが最新のリビジョンかどうかを指定します。
  • OriginalChecklistTemplateId; integer; 元のチェックリスト・テンプレートのシステム識別子。
  • Owner; string; チェックリスト・テンプレートの所有者。
  • OwnerId; integer; チェックリスト・テンプレート所有者の個人識別子。
  • ProcurementBU; string; チェックリスト・テンプレートが作成された調達ビジネス・ユニット。
  • ProcurementBUId; integer; チェックリスト・テンプレートが作成された調達ビジネス・ユニットのビジネス・ユニット識別子。
  • Revision; integer; チェックリスト・テンプレートのリビジョン番号。
  • Status; string; チェックリスト・テンプレートのステータス。 使用可能な値は、「ドラフト」、「アクティブ」、「非アクティブ」または「アーカイブ済」です。
  • StatusCode; string; チェックリスト・テンプレート・ステータスのコード。
• totalResults: boolean
  "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。

ヘッダー・パラメータ

• Effective-Of:
  このヘッダーは文字列値を受け入れます。 この文字列は、セミコロンで区切られた=のリストです。 有効日範囲操作の実行に使用されます。 受け入れられるパラメータは、RangeMode、RangeSpan、RangeStartDate、RangeEndDate、RangeStartSequenceおよびRangeEndSequenceです。 パラメータ値は常に文字列です。 RangeModeに指定できる値は、SET_LOGICAL_START、SET_LOGICAL_END、END_DATE、SET_EFFECTIVE_START、SET_EFFECTIVE_END、REPLACE_CORRECTION、REPLACE_UPDATE、RECONCILE_CORRECTION、CORRECTION、RECONCILE_UPDATE、UPDATE、ZAPおよびDELETE_CHANGESです。 RangeSpanに指定できる値は、PHYSICAL_ROW_END_DATEおよびLOGICAL_ROW_END_DATEです。 RangeStartDateおよびRangeEndDateの値は、yyyy-MM-dd形式の日付の文字列表現である必要があります。 RangeStartSequenceおよびRangeEndSequenceの値は、解析時に正の整数が生成されるように文字列である必要があります。
• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

レスポンス

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

• application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

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

本文 ()

ルート・スキーマ : complianceChecklistTemplates

タイプ: object

ソースを表示

• count(required): integer
  現在の範囲内で返されるリソース・インスタンス数。
• hasMore(required): boolean
  サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。 値がtrueの場合、サーバーから取得するリソースが増えます。 デフォルト値はfalseです。
• items: array Items
  タイトル: Items

  コレクション内の品目。
• limit(required): integer
  サーバーで使用される実際のページング・サイズ。
• links(required): array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• offset(required): integer
  現在のページで使用されるオフセット値。
• totalResults: integer
  "?totalResults=true"の場合、推定行数は含まれません。

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/complianceChecklistTemplates-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

ネストされたスキーマ : 品目

タイプ: array

タイトル: Items

コレクション内の品目。

ソースを表示

• Array of: object complianceChecklistTemplates-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/complianceChecklistTemplates-item-response"
    }
}

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

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

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

ネストされたスキーマ : complianceChecklistTemplates-item-response

タイプ: object

ソースを表示

• ActivationDate: string (date-time)
  テンプレートがアクティブ化された日時。
• ChecklistTemplate: string
  最大長: 80

  チェックリスト・テンプレートの名前。
• ChecklistTemplateDescription: string
  最大長: 240

  チェックリスト・テンプレートの説明。
• ChecklistTemplateId: integer (int64)
  チェックリスト・テンプレートのシステム識別子。 この識別子は、資格モデルIDとして格納されます。
• GlobalFlag: boolean
  最大長: 1

  デフォルト値: false

  チェックリスト・テンプレートをすべての調達ビジネス・ユニットで使用できるかどうかを指定します。
• HasInactiveOrOutdatedComponentsFlag: boolean
  読取り専用: true

  チェックリスト・テンプレートに、チェックリスト・セクションまたは質問の非アクティブまたは以前のリビジョンが含まれているかどうかを指定します。
• LatestRevisionFlag: boolean
  最大長: 1

  デフォルト値: true

  チェックリスト・テンプレートが最新のリビジョンかどうかを指定します。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• OriginalChecklistTemplateId: integer (int64)
  元のチェックリスト・テンプレートのシステム識別子。
• Owner: string
  タイトル: Owner

  読取り専用: true

  最大長: 240

  チェックリスト・テンプレートの所有者。
• OwnerId: integer (int64)
  チェックリスト・テンプレート所有者の個人識別子。
• ProcurementBU: string
  タイトル: Owning Procurement BU

  読取り専用: true

  最大長: 240

  チェックリスト・テンプレートが作成された調達ビジネス・ユニット。
• ProcurementBUId: integer (int64)
  チェックリスト・テンプレートが作成された調達ビジネス・ユニットのビジネス・ユニット識別子です。
• Revision: integer (int32)
  デフォルト値: 0

  チェックリスト・テンプレートのリビジョン番号。
• Status: string
  タイトル: Status

  読取り専用: true

  最大長: 80

  チェックリスト・テンプレートのステータス。 使用可能な値は、「ドラフト」、「アクティブ」、「非アクティブ」または「アーカイブ済」です。
• StatusCode: string
  最大長: 30

  デフォルト値: DRAFT

  チェックリスト・テンプレート・ステータスのコード。

{
    "type":"object",
    "properties":{
        "ProcurementBU":{
            "title":"Owning Procurement BU",
            "maxLength":240,
            "type":"string",
            "description":"Procurement business unit where the checklist template was created.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"Status of the checklist template. Possible values are Draft, Active, Inactive, or Archived.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcurementBUId":{
            "type":"integer",
            "description":"Business unit identifier of the procurement business unit where the checklist template was created.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OriginalChecklistTemplateId":{
            "type":"integer",
            "description":"System identifier for the original checklist template.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Owner":{
            "title":"Owner",
            "maxLength":240,
            "type":"string",
            "description":"Owner of the checklist template.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "HasInactiveOrOutdatedComponentsFlag":{
            "type":"boolean",
            "description":"Specifies whether the checklist template contains an inactive or previous revision of checklist sections or questions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChecklistTemplate":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the checklist template.",
            "nullable":false,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for the checklist template status.",
            "nullable":false,
            "default":"DRAFT",
            "x-queryable":true
        },
        "ChecklistTemplateDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the checklist template.",
            "nullable":true,
            "x-queryable":true
        },
        "Revision":{
            "type":"integer",
            "description":"Revision number of the checklist template.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "GlobalFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Specifies whether the checklist template is available across all procurement business units.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "OwnerId":{
            "type":"integer",
            "description":"Person identifier of the checklist template owner.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ActivationDate":{
            "type":"string",
            "description":"Date and time when the template was activated.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "LatestRevisionFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Specifies whether the checklist template is the latest revision.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "ChecklistTemplateId":{
            "type":"integer",
            "description":"System identifier of the checklist template. This identifier is stored as a qualification model ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        }
    }
}

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

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

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

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

タイプ: object

ソースを表示

• 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":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "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."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

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

タイプ: object

ソースを表示

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

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

トップに戻る

例

この例では、すべてのコンプライアンス・チェックリスト・テンプレートを取得する方法について説明します。

cURLコマンドの例

次のcURLコマンドを使用して、RESTリソースに対するリクエストを送信します:

curl -u username:password "https://servername/fscmRestApi/resources/version/complianceChecklistTemplates"

レスポンス本文の例

次の例には、レスポンス本文の内容がJSON形式で含まれます:

{
    "items": [
        {
            "ChecklistTemplateId": 300100582524651,
            "ChecklistTemplate": "Direct Acquisition",
            "ProcurementBU": "Vision Operations",
            "ProcurementBUId": 204,
            "Revision": 0,
            "Status": "Active",
            "StatusCode": "ACTIVE",
            "OriginalChecklistTemplateId": 300100582524651,
            "ChecklistTemplateDescription": "Demo: Direct Acquisition",
            "GlobalFlag": false,
            "Owner": "Clare Furey",
            "OwnerId": 100010026863783,
            "LatestRevisionFlag": true,
            "ActivationDate": "2023-10-10T05:39:36.526+00:00",
            "HasInactiveOrOutdatedComponentsFlag": false,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/complianceChecklistTemplates/300100582524651",
                    "name": "complianceChecklistTemplates",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/complianceChecklistTemplates/300100582524651",
                    "name": "complianceChecklistTemplates",
                    "kind": "item"
                }
            ]
        }, {
. . .
  } ],
. . .
}
],
    "count": 17,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/complianceChecklistTemplates",
            "name": "complianceChecklistTemplates",
            "kind": "collection"
        }
    ]
}

「トップに戻る」