機械翻訳について

ジャンプ先

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

すべての作業オーダー・ステータス・コードの取得

get

/crmRestApi/resources/11.13.18.05/woStatusCodeLookups

リクエスト

問合せパラメータ

• 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>
  
  使用可能なファインダ名および対応するファインダ変数を次に示します:
  
  

  • ByWoIntegrationCdFinder : 指定した作業オーダー統合コードを持つ作業オーダー・ステータス・コードを検索します。
    ファインダ変数:
    • BindWoIntegrationCd; string;作業オーダー統合コード。
  • PrimaryKey : 指定した作業オーダー・ステータス参照タイプおよび作業オーダー・ステータス・コードを持つ作業オーダー・ステータス・コードを検索します。
    ファインダ変数:
    • WoStatusMapId; integer;作業オーダーで選択された作業オーダー・ステータスのID。
• 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問合せパラメータを使用してこの収集リソースをフィルタできます:
  

  • CreatedBy; string; レコードを作成したユーザー。
  • CreationDate; string; レコードが作成された日時。
  • 摘要;文字列;作業指示ステータス・コードの摘要。
  • DisplaySequence; integer;作業オーダー・ステータス・コードの順序付け順序番号。
  • EnabledFlag;ブール。作業オーダー・ステータス・コードが有効かどうかを示します。
  • LastUpdateDate; string; レコードが最後に更新された日付。
  • LastUpdateLogin; string; レコードを最後に更新したユーザーのログイン。
  • LastUpdatedBy; string; レコードを最後に更新したユーザー。
  • 内容;文字列;作業オーダー・ステータス・コードの表示値。
  • UseCancelProcessFlag; boolean;取り消された作業オーダーの部品オーダーを取り消すプロセスを有効化するかどうかを示します。
  • WoIntegrationCd; string;作業指示のアプリケーション関連。 たとえば、作業オーダーがOracle Field Service Cloudのアクティビティに関連付けられている場合、このフィールドには、Oracle Field Service Cloudと統合された作業オーダーとして識別するコードが含まれます。
  • WoStatusCatCd; string; ステータスがオープン、取消済またはクローズ済であるかどうかを識別するステータス・コードのカテゴリ。
  • WoStatusCd; string;作業指示ステータス・コード。
  • WoStatusLookupType; string; アプリケーションの関連付けを示す作業オーダー・ステータス・コード参照タイプ。
  • WoStatusLookupTypeCd;文字列。作業オーダー統合の一意の作業オーダー・ステータスを定義する連結参照タイプおよび参照コード値。
  • WoStatusMapId; integer;作業オーダーで選択された作業オーダー・ステータスのID。
• 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のデフォルト・バージョンを選択します。

本文( )

ルート・スキーマ : woStatusCodeLookups

タイプ: 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/woStatusCodeLookups-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"LOV",
        "group":"OEC"
    }
}

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

タイプ: array

タイトル: Items

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

ソースを表示

• Array of: object woStatusCodeLookups-item-response

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

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

タイプ: object

ソースを表示

• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

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

  読取り専用: true

  レコードが作成された日時。
• Description: string
  タイトル: Description

  読取り専用: true

  最大長: 240

  作業オーダー・ステータス・コードの摘要。
• DisplaySequence: integer (int64)
  タイトル: Display Order

  読取り専用: true

  作業オーダー・ステータス・コードのオーダー連番。
• EnabledFlag: boolean
  タイトル: Enabled

  読取り専用: true

  最大長: 1

  デフォルト値: true

  作業オーダー・ステータス・コードが使用可能かどうかを示します。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  レコードが最後に更新された日付。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  レコードを最後に更新したユーザー。
• LastUpdateLogin: string
  タイトル: Last Update Login

  読取り専用: true

  最大長: 32

  レコードを最後に更新したユーザーのログイン。
• links: array Links
  タイトル: Links

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

  読取り専用: true

  最大長: 80

  作業オーダー・ステータス・コードの表示値。
• UseCancelProcessFlag: boolean
  タイトル: Enable Cancel Process

  最大長: 1

  取り消された作業オーダーの部品オーダーを取り消すプロセスを使用可能にするかどうかを示します。
• WoIntegrationCd: string
  最大長: 30

  作業オーダーのアプリケーション関連。 たとえば、作業オーダーがOracle Field Service Cloudのアクティビティに関連付けられている場合、このフィールドには、Oracle Field Service Cloudと統合された作業オーダーとして識別するコードが含まれます。
• WoStatusCatCd: string
  タイトル: Status Category

  最大長: 30

  ステータスがオープン、取消済またはクローズ済であるかどうかを識別するステータス・コードのカテゴリ。
• WoStatusCd: string
  タイトル: Status Code

  最大長: 30

  作業オーダー・ステータス・コード。
• WoStatusLookupType: string
  最大長: 30

  アプリケーション関連を示す作業オーダー・ステータス・コード参照タイプです。
• WoStatusLookupTypeCd: string
  タイトル: Concatenated Status Lookup

  最大長: 64

  作業オーダー統合の一意の作業オーダー・ステータスを定義する連結参照タイプおよび参照コード値。
• WoStatusMapId: integer (int64)
  タイトル: Status ID

  読取り専用: true

  作業オーダーで選択された作業オーダー・ステータスのID。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the work order status code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Order",
            "type":"integer",
            "description":"The ordering sequence number for the work order status code.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WoStatusCatCd":{
            "title":"Status Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the status code identifying whether the status is open, canceled, or closed.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "WoStatusLookupType":{
            "maxLength":30,
            "type":"string",
            "description":"The work order status code lookup type, indicating the application association.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "WoIntegrationCd"
                ]
            },
            "x-queryable":true
        },
        "UseCancelProcessFlag":{
            "title":"Enable Cancel Process",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether to enable the process to cancel part orders on a work order that had been canceled.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the work order status code is enabled.",
            "nullable":false,
            "readOnly":true,
            "default":true,
            "x-queryable":true
        },
        "WoIntegrationCd":{
            "maxLength":30,
            "type":"string",
            "description":"The application association of the work order. For example, if the work order is associated to an activity in Oracle Field Service Cloud, this field will contain a code identifying it as a work order integrated with Oracle Field Service Cloud.",
            "nullable":false,
            "x-queryable":true
        },
        "Meaning":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"The display value for the work order status code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WoStatusCd":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The work order status code.",
            "nullable":false,
            "x-queryable":true
        },
        "WoStatusMapId":{
            "title":"Status ID",
            "type":"integer",
            "description":"The ID for the work order status selected on the work order.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WoStatusLookupTypeCd":{
            "title":"Concatenated Status Lookup",
            "maxLength":64,
            "type":"string",
            "description":"The concatenated lookup type and lookup code value that defines the unique work order status for a work order integration.",
            "nullable":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."
                }
            }
        }
    }
}

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

タイプ: object

ソースを表示

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

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

「トップに戻る」