機械翻訳について

ジャンプ先

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

すべての在庫保管ロケーションを取得

get

/fscmRestApi/resources/11.13.18.05/stockingLocations

リクエスト

問合せパラメータ

• 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 : 指定した主キー基準に従って在庫事業所を検索します。
    ファインダ変数:
    • StockLocationId; 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;Loc!=NY
  
  フォーマット : ?q=expression1;expression2
  
  次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
  

  • 条件、文字列、保管ロケーション保管ロケーションの条件。 有効な値は使用可能および欠陥です。 受け入れられる値のリストは、参照タイプORA_RCL_STOCK_LOC_CONDITIONで定義されます。
  • ConditionMeaning; string;保管ロケーション保管ロケーションの条件を示す値。 有効な値は使用可能および欠陥です。 受け入れられる値のリストは、参照タイプORA_RCL_STOCK_LOC_CONDITIONで定義されます。
  • LocationType; string;場所のタイプ。 有効な値は、TECHNICIAN、UNMANNED、MANNEDおよびSITE_DEDICATEDです。 受け入れられる値のリストは、参照タイプORA_RCL_STOCK_LOC_TYPEで定義されます。 事業所タイプを追加できません。
  • LocationTypeMeaning; string;場所タイプの説明。 有効な値は、技術者、無人倉庫、有人倉庫およびサイト専用倉庫です。 受け入れられる値のリストは、参照タイプORA_RCL_STOCK_LOC_TYPEで定義されます。 事業所タイプを追加できません。
  • OrganizationCode; string;サービス・ロジスティクス属性が追加または更新される在庫組織を識別する略称。
  • OrganizationId; integer; サービス・ロジスティクス属性が追加または更新される在庫組織を一意に識別する値。
  • StockLocationId; integer; 在庫事業所を一意に識別する値。
  • 保管場所、文字列。サービス・ロジスティクス属性が追加または更新される保管場所の名前。
• 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のデフォルト・バージョンを選択します。

本文( )

ルート・スキーマ : stockingLocations

タイプ: 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/stockingLocations-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"Maintenance",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

ネストされたスキーマ : アイテム

タイプ: array

タイトル: Items

コレクション内のアイテム。

ソースを表示

• Array of: object stockingLocations-item-response

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

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

タイプ: object

ソースを表示

• Condition: string
  最大長: 10

  保管ロケーション在庫事業所の条件です。 有効な値は使用可能および欠陥です。 受け入れられる値のリストは、参照タイプORA_RCL_STOCK_LOC_CONDITIONで定義されます。
• ConditionMeaning: string
  最大長: 80

  保管ロケーション在庫事業所の条件を示す値です。 有効な値は使用可能および欠陥です。 受け入れられる値のリストは、参照タイプORA_RCL_STOCK_LOC_CONDITIONで定義されます。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• LocationType: string
  最大長: 10

  ロケーションのタイプ。 有効な値は、TECHNICIAN、UNMANNED、MANNEDおよびSITE_DEDICATEDです。 受け入れられる値のリストは、参照タイプORA_RCL_STOCK_LOC_TYPEで定義されます。 事業所タイプを追加できません。
• LocationTypeMeaning: string
  最大長: 80

  事業所タイプの摘要。 有効な値は、技術者、無人倉庫、有人倉庫およびサイト専用倉庫です。 受け入れられる値のリストは、参照タイプORA_RCL_STOCK_LOC_TYPEで定義されます。 事業所タイプを追加できません。
• OrganizationCode: string
  最大長: 18

  サービス・ロジスティクス属性が追加または更新される在庫組織を識別する略称です。
• OrganizationId: integer (int64)
  サービス・ロジスティクス属性が追加または更新される在庫組織を一意に識別する値。
• siteDedicatedLocations: array Site Dedicated Locations
  タイトル: Site Dedicated Locations

  Site Dedicated Locationsリソースは、サイト専用の保管場所の住所をRCL_SITE_DEDICATED_LOCATIONS表に作成して、関連するサービス・ロジスティクス保管場所の部品を使用できる顧客サイトを定義します。
• StockLocationId: integer (int64)
  在庫事業所を一意に識別する値です。
• Subinventory: string
  最大長: 10

  サービス・ロジスティクス属性が追加または更新される保管場所の名前。

{
    "type":"object",
    "properties":{
        "Condition":{
            "maxLength":10,
            "type":"string",
            "description":"Condition of subinventory stocking locations. Valid values are Usable and Defective. A list of accepted values is defined in the lookup type ORA_RCL_STOCK_LOC_CONDITION.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StockLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the stocking location.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "siteDedicatedLocations":{
            "title":"Site Dedicated Locations",
            "type":"array",
            "description":"The Site Dedicated Locations resource creates site dedicated stocking location addresses in the RCL_SITE_DEDICATED_LOCATIONS table to define which customer sites the parts in the associated service logistics stocking location can be used.",
            "items":{
                "$ref":"#/components/schemas/stockingLocations-siteDedicatedLocations-item-response"
            }
        },
        "Subinventory":{
            "maxLength":10,
            "type":"string",
            "description":"Name of the subinventory for which service logistics attributes are added or updated.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the inventory organization for which service logistics attributes are added or updated.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization for which service logistics attributes are added or updated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":35
            },
            "x-queryable":true
        },
        "ConditionMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"Value that indicates the condition of subinventory stocking locations. Valid values are Usable and Defective. A list of accepted values is defined in the lookup type ORA_RCL_STOCK_LOC_CONDITION.",
            "nullable":false,
            "x-queryable":true
        },
        "LocationType":{
            "maxLength":10,
            "type":"string",
            "description":"Type of location. Valid values are TECHNICIAN, UNMANNED, MANNED, and SITE_DEDICATED. A list of accepted values is defined in the lookup type ORA_RCL_STOCK_LOC_TYPE. You cannot add additional location types.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LocationTypeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"Description of the location type. Valid values are Technician, Unmanned Warehouse, Manned Warehouse, and Site Dedicated Warehouse. A list of accepted values is defined in the lookup type ORA_RCL_STOCK_LOC_TYPE. You cannot add additional location types.",
            "nullable":false,
            "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"
    }
}

ネストされたスキーマ : サイト専用のロケーション

タイプ: array

タイトル: Site Dedicated Locations

Site Dedicated Locationsリソースは、サイト専用の保管場所の住所をRCL_SITE_DEDICATED_LOCATIONS表に作成して、関連するサービス・ロジスティクス保管場所の部品を使用できる顧客サイトを定義します。

ソースを表示

• Array of: object stockingLocations-siteDedicatedLocations-item-response

{
    "title":"Site Dedicated Locations",
    "type":"array",
    "description":"The Site Dedicated Locations resource creates site dedicated stocking location addresses in the RCL_SITE_DEDICATED_LOCATIONS table to define which customer sites the parts in the associated service logistics stocking location can be used.",
    "items":{
        "$ref":"#/components/schemas/stockingLocations-siteDedicatedLocations-item-response"
    }
}

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

タイプ: 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."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

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

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

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

タイプ: object

ソースを表示

• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• PartySiteId: integer (int64)
  サービス・ロジスティクス在庫事業所表(RCL_STOCK_LOCATION)に関連付けられた顧客サイト(HZ_PARTY_SITES)を一意に識別する値。
• PartySiteNumber: string
  最大長: 30

  サービス・ロジスティクス在庫事業所表(RCL_STOCK_LOCATION)に関連付けられた顧客サイト(HZ_PARTY_SITES)を識別する番号。
• SiteDedicatedLocId: integer (int64)
  専用サイト表(RCL_SITE_DEDICATED_LOCATIONS)のサイト専用ロケーション・レコードを一意に識別する値。
• StockLocationId: integer (int64)
  サービス・ロジスティクス在庫事業所表(RCL_STOCK_LOCATION)の行を一意に識別する値。

{
    "type":"object",
    "properties":{
        "PartySiteNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the customer site (HZ_PARTY_SITES) associated with the service logistics stocking locations table (RCL_STOCK_LOCATION).",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "StockLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the row in the service logistics stocking location table (RCL_STOCK_LOCATION).",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SiteDedicatedLocId":{
            "type":"integer",
            "description":"Value that uniquely identifies the site dedicated location record in the dedicated sites table (RCL_SITE_DEDICATED_LOCATIONS).",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartySiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer site (HZ_PARTY_SITES) associated with the service logistics stocking locations table (RCL_STOCK_LOCATION).",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "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"
    }
}

「トップに戻る」