機械翻訳について

ジャンプ先

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

すべての分類の取得

get

/fscmRestApi/resources/11.13.18.05/suppliers/{SupplierId}/child/businessClassifications

リクエスト

パス・パラメータ

• SupplierId(required): integer(int64)
  サプライヤを一意に識別する値。

問合せパラメータ

• dependency: string
  このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前に、親リソース・インスタンスにフィールドが設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2
  
  フォーマット: <attr1>=<val1>,<attr2>=<value2>
• 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
  コレクションを検索するための事前定義済ファインダとして使用されます。
  
  フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  使用可能なファインダ名および対応するファインダ変数を次に示します:
  
  

  • PrimaryKey : 主キーに従ってサプライヤ分類を検索します。
    ファインダ変数:
    • ClassificationId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
  

  • CertificateExpirationDate; string; 認証機関が発行する事業分類の証明書が失効する日付。
  • CertificateNumber; string; 認証機関が事業分類のために発行する証明書。
  • CertificateStartDate; string; 認証機関が発行する事業分類の証明書が有効になる日付。
  • CertifyingAgency; string; サプライヤの事業分類を証明する代理店。
  • CertifyingAgencyId; integer; サプライヤの事業分類を証明する機関を一意に識別する値。
  • Classification; string; サプライヤ・ビジネスの分類。
  • ClassificationCode; string; サプライヤ・ビジネスの分類を識別する略称。 受け入れられる値のリストは、参照タイプPOZ_BUSINESS_CLASSIFICATIONSで定義されます。 設定およびメンテナンス作業領域およびビジネス分類参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
  • ClassificationId; integer; サプライヤ・ビジネスの分類を一意に識別する値。
  • ConfirmedOnDate; string; アプリケーションがサプライヤの事業分類を確認した日付。
  • Notes; string; サプライヤの事業分類を説明するノート。 サプライヤまたは分類を管理する個人は、ノートを入力できます。
  • OtherCertifyingAgency; string; サプライヤの事業分類を証明する代理店。 この属性は、設定およびメンテナンス作業領域の「認証機関の管理」ページで必要なエージェンシを指定していない場合に使用します。
  • ProvidedByContactId; integer; ビジネス分類詳細を提供するサプライヤ組織内の個人を一意に識別する値。
  • Status; string; サプライヤの事業分類のステータス。
  • Subclassification; string; 少数民族が事業分類を所有する場合のサブ分類を記述します。
  • SubclassificationCode; string; 少数民族が事業分類を所有する場合のサブ分類を識別する略称。 受け入れられる値のリストは、参照タイプPOZ_MINORITY_GROUPで定義されます。 設定およびメンテナンス作業領域および標準参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
• totalResults: boolean
  "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。

ヘッダー・パラメータ

• 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のデフォルト・バージョンを選択します。

本文 ()

ルート・スキーマ : suppliers-businessClassifications

タイプ: 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/suppliers-businessClassifications-item-response"
            }
        }
    }
}

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

タイプ: array

タイトル: Items

コレクション内の品目。

ソースを表示

• Array of: object suppliers-businessClassifications-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/suppliers-businessClassifications-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"
    }
}

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

タイプ: object

ソースを表示

• attachments: array Attachments
  タイトル: Attachments

  添付リソースは、サプライヤ・ビジネス分類の添付を管理します。
• CertificateExpirationDate: string (date)
  タイトル: Expiration Date

  認証機関が発行する事業分類の証明書が失効する日付。
• CertificateNumber: string
  タイトル: Certificate Number

  最大長: 80

  認証機関がビジネス分類に対して発行する証明書。
• CertificateStartDate: string (date)
  タイトル: Start Date

  認証機関が発行する事業分類の証明書が有効になる日付。
• CertifyingAgency: string
  タイトル: Certifying Agency

  最大長: 255

  サプライヤの事業分類を証明する機関です。
• CertifyingAgencyId: integer (int64)
  タイトル: Certifying Agency

  サプライヤの事業分類を証明する機関を一意に識別する値です。
• Classification: string
  タイトル: Classification

  最大長: 80

  サプライヤ・ビジネスの分類です。
• ClassificationCode: string
  タイトル: Classification

  最大長: 30

  サプライヤ・ビジネスの分類を識別する略称です。 受け入れられる値のリストは、参照タイプPOZ_BUSINESS_CLASSIFICATIONSで定義されます。 設定およびメンテナンス作業領域およびビジネス分類参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
• ClassificationId: integer (int64)
  読取り専用: true

  サプライヤ・ビジネスの分類を一意に識別する値。
• ConfirmedOnDate: string (date)
  タイトル: Confirmed On

  アプリケーションがサプライヤの事業分類を確認した日付。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  サプライヤ・レコードを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  ユーザーがサプライヤ・レコードを作成した日付。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  ユーザーが最後にサプライヤ・レコードを更新した日時。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  最後にサプライヤ・レコードを更新したユーザー。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• Notes: string
  タイトル: Notes

  最大長: 1000

  サプライヤのビジネス分類を説明するノート。 サプライヤまたは分類を管理する個人は、ノートを入力できます。
• OtherCertifyingAgency: string
  タイトル: Other Certifying Agency

  最大長: 255

  サプライヤの事業分類を証明する機関です。 この属性は、設定およびメンテナンス作業領域の「認証機関の管理」ページで必要なエージェンシを指定していない場合に使用します。
• ProvidedByContactId: integer (int64)
  ビジネス分類詳細を提供するサプライヤ組織内の個人を一意に識別する値。
• ProvidedByEmail: string
  ビジネス分類詳細を提供するサプライヤ組織内の個人のEメール。
• ProvidedByUserFirstName: string
  ビジネス分類詳細を提供するサプライヤ組織内の個人の名。
• ProvidedByUserLastName: string
  ビジネス分類詳細を提供するサプライヤ組織内の個人の姓。
• Status: string
  タイトル: Status

  読取り専用: true

  最大長: 255

  サプライヤのビジネス分類のステータスです。
• Subclassification: string
  タイトル: Subclassification

  最大長: 80

  少数民族が事業分類を所有する場合のサブ分類を示します。
• SubclassificationCode: string
  タイトル: Subclassification

  最大長: 240

  少数民族が事業分類を所有する場合のサブ分類を識別する略称です。 受け入れられる値のリストは、参照タイプPOZ_MINORITY_GROUPで定義されます。 設定およびメンテナンス作業領域および標準参照の管理タスクを使用して、この属性の値をレビューおよび更新します。

{
    "type":"object",
    "properties":{
        "Status":{
            "title":"Status",
            "maxLength":255,
            "type":"string",
            "description":"Status of the business classification for the supplier.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "CertificateExpirationDate",
                    "CertificateStartDate"
                ]
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the supplier record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Subclassification":{
            "title":"Subclassification",
            "maxLength":80,
            "type":"string",
            "description":"Describes the subclassification when a minority owns the business classification.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ProvidedByUserFirstName":{
            "type":"string",
            "description":"First name of the person in the supplier organization who provides business classification details.",
            "nullable":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the user created the supplier record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CertifyingAgency":{
            "title":"Certifying Agency",
            "maxLength":255,
            "type":"string",
            "description":"Agency that certifies the business classification for the supplier.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the supplier record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The Attachments resource manages attachments for a supplier business classification.",
            "items":{
                "$ref":"#/components/schemas/suppliers-businessClassifications-attachments-item-response"
            }
        },
        "CertificateStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date when the certificate that the certifying agency issues for the business classification goes into effect.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CertifyingAgencyId":{
            "title":"Certifying Agency",
            "type":"integer",
            "description":"Value that uniquely identifies the agency that certifies the business classification for the supplier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProvidedByContactId":{
            "type":"integer",
            "description":"Value that uniquely identifies the person in the supplier organization who provides the business classification details.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ProvidedByEmail":{
            "type":"string",
            "description":"Email of the person in the supplier organization who provides business classification details.",
            "nullable":true,
            "x-queryable":false
        },
        "ClassificationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the classification for the supplier business.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CertificateExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Date when the certificate that the certifying agency issues for the business classification expires.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ClassificationCode":{
            "title":"Classification",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the classification for the supplier business. A list of accepted values is defined in the lookup type POZ_BUSINESS_CLASSIFICATIONS. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Business Classification Lookup task.",
            "nullable":false,
            "x-queryable":true
        },
        "Classification":{
            "title":"Classification",
            "maxLength":80,
            "type":"string",
            "description":"Classification for the supplier business.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ProvidedByUserLastName":{
            "type":"string",
            "description":"Last name of the person in the supplier organization who provides business classification details.",
            "nullable":true,
            "x-queryable":false
        },
        "ConfirmedOnDate":{
            "title":"Confirmed On",
            "type":"string",
            "description":"Date when the application confirmed the business classification for the supplier.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CertificateNumber":{
            "title":"Certificate Number",
            "maxLength":80,
            "type":"string",
            "description":"Certificate that the certifying agency issues for the business classification.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubclassificationCode":{
            "title":"Subclassification",
            "maxLength":240,
            "type":"string",
            "description":"Abbreviation that identifies the subclassification when a minority owns the business classification. A list of accepted values is defined in the lookup type POZ_MINORITY_GROUP. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "OtherCertifyingAgency":{
            "title":"Other Certifying Agency",
            "maxLength":255,
            "type":"string",
            "description":"Agency that certifies the business classification for the supplier. Use this attribute when the Manage Certifying Agencies page in the Setup and Maintenance work area does not specify the agency you require.",
            "nullable":true,
            "x-queryable":true
        },
        "Notes":{
            "title":"Notes",
            "maxLength":1000,
            "type":"string",
            "description":"Notes that describe the business classification for the supplier. The supplier or the person who manages the classification can enter notes.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date and time when the user most recently updated the supplier record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

ネストされたスキーマ : 添付

タイプ: array

タイトル: Attachments

添付リソースは、サプライヤ・ビジネス分類の添付を管理します。

ソースを表示

• Array of: object suppliers-businessClassifications-attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The Attachments resource manages attachments for a supplier business classification.",
    "items":{
        "$ref":"#/components/schemas/suppliers-businessClassifications-attachments-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"
    }
}

ネストされたスキーマ : suppliers-businessClassifications-attachments-item-response

タイプ: object

ソースを表示

• AsyncTrackerId: string
  タイトル: Asynchronous Upload Tracker Id

  アップロードされたファイルのトラッキングに使用される識別子。
• AttachedDocumentId: integer (int64)
  タイトル: Attached Document Id

  質問の添付を一意に識別する値。 これは、ユーザーが質問にドキュメントを添付するときにアプリケーションが作成する主キーです。
• CategoryName: string
  タイトル: Category

  最大長: 30

  添付のカテゴリ。
• ContentRepositoryFileShared: boolean
  タイトル: Shared

  次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、添付は共有されます。 falseの場合、添付は共有されません。 デフォルト値はfalseです。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 255

  添付を作成したユーザー。
• CreatedByUserName: string
  タイトル: Created By User Name

  読取り専用: true

  質問の添付を作成したユーザーのサインイン詳細。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  ユーザーが添付レコードを作成した日付。
• DatatypeCode: string
  タイトル: Type

  最大長: 30

  デフォルト値: FILE

  データ型を識別する略語。
• Description: string
  タイトル: Description

  最大長: 255

  添付の説明。
• DmDocumentId: string
  最大長: 255

  添付されたドキュメントを一意に識別する値。
• DmFolderPath: string
  タイトル: Dm Folder Path

  最大長: 1000

  添付のフォルダ・パス。
• DmVersionNumber: string
  最大長: 255

  添付文書のバージョンを識別する番号です。
• DownloadInfo: string
  タイトル: DownloadInfo

  添付ファイルをプログラムで取得するために使用される情報を含む文字列として表されるJSONオブジェクト。
• ErrorStatusCode: string
  タイトル: Error Status Code

  添付のエラー・コード(ある場合)を識別する略称です。
• ErrorStatusMessage: string
  タイトル: Error Status Message

  添付のエラー・メッセージのテキスト(存在する場合)。
• ExpirationDate: string (date-time)
  タイトル: Expiration Date

  添付のコンテンツが失効する日付。
• FileContents: string (byte)
  タイトル: File Contents

  添付ファイルの内容。
• FileName: string
  タイトル: File Name

  最大長: 2048

  添付のファイル名。
• FileUrl: string
  タイトル: File Url

  添付ファイルのURL(Uniform Resource Locator)。
• FileWebImage: string (byte)
  タイトル: File Web Image

  読取り専用: true

  ソースが変換可能なイメージの場合に、.png形式で表示されるファイルのbase64でエンコードされたイメージ。
• LastUpdateDate: string (date-time)
  タイトル: Last Update Date

  読取り専用: true

  ユーザーが質問に添付したドキュメントを最後に更新した日時。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 255

  ユーザーが質問に添付したドキュメントを最後に更新したユーザーのサインイン詳細。
• LastUpdatedByUserName: string
  タイトル: Last Updated By User

  読取り専用: true

  質問の添付を更新したユーザーのサインイン詳細。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• Title: string
  タイトル: Title

  添付のタイトル。
• UploadedFileContentType: string
  タイトル: Uploaded File Content Type

  添付のコンテンツ・タイプ。
• UploadedFileLength: integer
  タイトル: File Size

  添付ファイルの長さ。
• UploadedFileName: string
  タイトル: Uploaded File Name

  添付ファイルの名前。
• UploadedText: string
  タイトル: Uploaded Text

  添付のテキスト。
• Uri: string
  タイトル: Uri

  最大長: 4000

  添付ファイルを識別するURI (Uniform Resource Identifier)。
• Url: string
  タイトル: Url

  最大長: 4000

  添付ファイルを識別するURI (Uniform Resource Identifier)。
• UserName: string
  タイトル: User Name

  読取り専用: true

  最大長: 255

  添付の追加または変更時にユーザーが使用したサインイン詳細。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the user created the attachment record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"File name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"URI (Uniform Resource Identifier) that identifies the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"URI (Uniform Resource Identifier) that identifies the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Value that uniquely identifies the attachment of a question. It is a primary key that the application creates when the user attaches a document to the question.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"Sign in details for the user who created the attachment for the question.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Length of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the version of the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"Sign in details of the user who most recently updated the document that a user attached to the question.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Text of the error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"Sign in details that the user used when adding or modifying the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"User who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"Sign in details for the user used who updated the attachment for the question.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL (Uniform Resource Locator) of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the attachment is shared. If false, then the attachment is not shared. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Date when the content in the attachment expires.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Abbreviation that identifies the error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date and time when the user most recently updated the document that a user attached to the question.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"An identifier used for tracking the uploaded files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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

タイプ: 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/suppliers/SupplierId/child/businessClassifications"

レスポンス本文の例

JSON形式のレスポンス本文の例を次に示します。

{
  "items" : [ {
    "ClassificationId" : 300100153044415,
    "ClassificationCode" : "HUB_ZONE",
    "Classification" : "Hub Zone",
    "SubclassificationCode" : null,
    "Subclassification" : null,
    "Status" : "CURRENT",
    "CertifyingAgencyId" : 85,
    "CertifyingAgency" : "Hub Zone Association, Chicago",
    "OtherCertifyingAgency" : null,
    "CertificateNumber" : "424A09-343",
    "CertificateStartDate" : "2017-06-01",
    "CertificateExpirationDate" : "2019-05-31",
    "Notes" : null,
    "ProvidedByUserFirstName" : null,
    "ProvidedByUserLastName" : null,
    "ConfirmedOnDate" : "2018-06-01",
    "links" : [ {
      "rel" : "self",
      "href" : "https://servername/fscmRestApi/resources/version/suppliers/300100153044388/child/businessClassifications/300100153044415",
      "name" : "businessClassifications",
      "kind" : "item",
      "properties" : {
        "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
      }
    }, {
      "rel" : "canonical",
      "href" : "https://servername/fscmRestApi/resources/version/suppliers/300100153044388/child/businessClassifications/300100153044415",
      "name" : "businessClassifications",
      "kind" : "item"
    }, {
      "rel" : "parent",
      "href" : "https://servername/fscmRestApi/resources/version/suppliers/300100153044388",
      "name" : "suppliers",
      "kind" : "item"
    }, {
      "rel" : "child",
      "href" : "https://servername/fscmRestApi/resources/version/suppliers/300100153044388/child/businessClassifications/300100153044415/child/attachments",
      "name" : "attachments",
      "kind" : "collection"
    } ]
  }, {
    "ClassificationId" : 300100153044416,
    "ClassificationCode" : "MINORITY_OWNED",
    "Classification" : "Minority Owned",
    "SubclassificationCode" : "Hispanic",
    "Subclassification" : "Hispanic",
    "Status" : "CURRENT",
    "CertifyingAgencyId" : 64,
    "CertifyingAgency" : "Minority Administration, New York",
    "OtherCertifyingAgency" : null,
    "CertificateNumber" : "34-DFE299424",
    "CertificateStartDate" : null,
    "CertificateExpirationDate" : null,
    "Notes" : null,
    "ProvidedByUserFirstName" : null,
    "ProvidedByUserLastName" : null,
    "ConfirmedOnDate" : "2018-06-01",
    "links" : [ {
      "rel" : "self",
      "href" : "https://servername/fscmRestApi/resources/version/suppliers/300100153044388/child/businessClassifications/300100153044416",
      "name" : "businessClassifications",
      "kind" : "item",
      "properties" : {
        "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
      }
    }, {
      "rel" : "canonical",
      "href" : "https://servername/fscmRestApi/resources/version/suppliers/300100153044388/child/businessClassifications/300100153044416",
      "name" : "businessClassifications",
      "kind" : "item"
    }, {
      "rel" : "parent",
      "href" : "https://servername/fscmRestApi/resources/version/suppliers/300100153044388",
      "name" : "suppliers",
      "kind" : "item"
    }, {
      "rel" : "child",
      "href" : "https://servername/fscmRestApi/resources/version/suppliers/300100153044388/child/businessClassifications/300100153044416/child/attachments",
      "name" : "attachments",
      "kind" : "collection"
    } ]
  } ],
  "count" : 2,
  "hasMore" : false,
  "limit" : 25,
  "offset" : 0,
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername/fscmRestApi/resources/version/suppliers/300100153044388/child/businessClassifications",
    "name" : "businessClassifications",
    "kind" : "collection"
  } ]
}

「トップに戻る」