機械翻訳について

ジャンプ先

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

ジョブ割当上書きの取得

get

/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan/{RevenuePlanUniqID}/child/JobAssignmentOverride/{JobAssignmentOverrideUniqID}

リクエスト

パス・パラメータ

• JobAssignmentOverrideUniqID(required): string
  このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: products?q=InventoryItemId=
• RevenuePlanUniqID(required): string
  これは、収益プラン・リソースに対する複合キー(BillPlanIdおよびMajorVersion)を構成する属性のハッシュ・キーで、収益プランのインスタンスを一意に識別するために使用されます。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、収益プランの特定のインスタンスにナビゲートするために、主キー値に対するフィルタを使用して収益プラン・コレクション・リソースを問い合せる必要があります。
  
  次に例を示します: RevenuePlan?q=BillPlanId=<value1>;MajorVersion=<value2>
• contractsUniqID(required): string
  これは、Contractsリソースの複合キーを構成し、Contractsのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、Contractsの特定のインスタンスに移動してハッシュ・キーを取得するために、Contractsコレクション・リソースを問い合せる必要があります。

問合せパラメータ

• 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
• links: string
  このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
  
  例:
  self,canonical
  
• onlyData: boolean
  リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。

ヘッダー・パラメータ

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

本文( )

ルート・スキーマ : contracts-RevenuePlan-JobAssignmentOverride-item-response

タイプ: object

ソースを表示

• BillingTitle: string
  タイトル: Billing Title Override

  最大長: 80

  この請求プランの個人に割り当てられている上書きジョブ・タイトルの名前。 顧客への請求書の表示に使用されます。
• ContractLineId: integer (int64)
  タイトル: Contract Line ID

  ジョブ割当上書きが定義されている契約明細の一意識別子です。
• ContractLineNumber: string
  タイトル: Contract Line Number

  最大長: 150

  ジョブ割当上書きが定義されている契約明細。
• EmailAddress: string
  タイトル: Email

  最大長: 240

  職務割当上書きが定義されている電子メール・アドレス。
• EndDateActive: 文字列(日付)
  タイトル: End Date

  ジョブ・アサイメントの上書きが適用される日付。
• ExternalReferenceKey: string
  タイトル: External Reference Key

  最大長: 150

  ソース・アプリケーションでのジョブ割当上書きの一意識別子です。 外部webサービスを介して作成されたジョブ割当上書きを識別するために使用されます。
• ExternalSourceKey: string
  タイトル: External Source Key

  最大長: 150

  ジョブ割当上書きが発生したソース・アプリケーションの一意の識別子。 外部webサービスを介して作成されたジョブ割当上書きを識別するために使用されます。
• JobAssignmentOverrideId: integer (int64)
  タイトル: Job Assignment Override ID

  請求プランのジョブ割当上書きの一意の識別子で、その個人の通常のジョブではなく、特定の個人に割り当てられたネゴシエーション済ジョブを識別します。
• JobCode: string
  タイトル: Job Code

  この請求または収益プランの個人に割り当てられている上書きのジョブ・コード。
• JobId: integer (int64)
  タイトル: Job ID

  この請求または収益プランの個人に割り当てられている上書きジョブの一意識別子です。
• JobName: string
  タイトル: Job Name

  最大長: 240

  この請求または収益プランの個人に割り当てられている上書きのジョブ名。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• MajorVersion: integer (int64)
  タイトル: Version

  デフォルト値: 1

  この特定のジョブ割当セット上書き詳細を含む契約のバージョン。
• PersonId: integer (int64)
  タイトル: Person ID

  ジョブ・アサイメント上書きが定義されている個人の一意の識別子。
• PersonName: string
  タイトル: Person

  最大長: 2000

  ジョブ・アサイメント上書きが定義されている個人。
• PersonNumber: string
  タイトル: Person Number

  最大長: 30

  ジョブ・アサイメント上書きが定義されている個人番号。
• StartDateActive: 文字列(日付)
  タイトル: Start Date

  ジョブ・アサイメントの上書きが適用される開始日。

{
    "type":"object",
    "properties":{
        "MajorVersion":{
            "title":"Version",
            "type":"integer",
            "description":"The version of the contract containing this particular set of job assignment override details.",
            "format":"int64",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonNumber":{
            "title":"Person Number",
            "maxLength":30,
            "type":"string",
            "description":"The person number for whom the job assignment override is defined.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "EmailAddress",
                    "PersonName"
                ]
            },
            "x-queryable":true
        },
        "ExternalReferenceKey":{
            "title":"External Reference Key",
            "maxLength":150,
            "type":"string",
            "description":"Unique identifier of the job assignment override in the source application. Used to identify job assignment overrides created through external webservices.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonName":{
            "title":"Person",
            "maxLength":2000,
            "type":"string",
            "description":"The person for whom the job assignment override is defined.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "JobAssignmentOverrideId":{
            "title":"Job Assignment Override ID",
            "type":"integer",
            "description":"The unique identifier of the job assignment override on the bill plan that identifies the negotiated job assigned to a specific person, rather than the normal job for that person.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExternalSourceKey":{
            "title":"External Source Key",
            "maxLength":150,
            "type":"string",
            "description":"Unique identifier of the source application from where the job assignment override originates. Used to identify job assignment overrides created through external webservices.",
            "nullable":true,
            "x-queryable":true
        },
        "ContractLineId":{
            "title":"Contract Line ID",
            "type":"integer",
            "description":"Unique identifier of the contract line for which the job assignment override is defined.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "JobName":{
            "title":"Job Name",
            "maxLength":240,
            "type":"string",
            "description":"The job name of the override being assigned to the person for this bill or revenue plan.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "BillingTitle":{
            "title":"Billing Title Override",
            "maxLength":80,
            "type":"string",
            "description":"Name of the override job title being assigned to the person for this bill plan. Used to display on the invoice to the customer.",
            "nullable":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":240,
            "type":"string",
            "description":"The email address for whom the job assignment override is defined.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "PersonName"
                ]
            },
            "x-queryable":true
        },
        "ContractLineNumber":{
            "title":"Contract Line Number",
            "maxLength":150,
            "type":"string",
            "description":"The contract line for which the job assignment override is defined.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"The date from which a job assignment override applies.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "EndDateActive":{
            "title":"End Date",
            "type":"string",
            "description":"The date to which a job assignment override applies.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"Unique identifier of the person for whom the job assignment override is defined.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "EmailAddress",
                    "PersonName",
                    "PersonNumber"
                ]
            },
            "x-queryable":true
        },
        "JobCode":{
            "title":"Job Code",
            "type":"string",
            "description":"The job code of the override being assigned to the person for this bill or revenue plan.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "JobId":{
            "title":"Job ID",
            "type":"integer",
            "description":"Unique identifier of the override job being assigned to the person for this bill or revenue plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "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"
    }
}

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

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

「トップに戻る」