概念︰驗證 Worktag REST API

「維護 Worktag 用途」
報告中交易類型 Worktag 的設定。
請在
「維護 Worktag 類型優先順序」
任務中設定 Web 服務的預設 Worktag 類型。
「維護相關 Worktag 用途」
報告中相關 Worktag 的設定。
公司限制

https://{tenantHostname}/api/worktag/{version}/{tenantName}

https://yourTenantHostName.com/api/worktag/v1/gms

taggableConfiguration

(必填) 驗證的可標記類型。指定在

「維護 Worktag 用途」

報告中為交易配置的可標記類型參考 ID。 使用參考 ID 格式

Taggable_Type_ID={referenceID}

。 您可以從

「檢視可標記類型」

任務取得可標記類型的參考 ID。範例︰

"taggableConfiguration": {"id":"Taggable_Type_ID=EXPENSE_REPORT"}

某些 Worktag 類型支援更精細的配置。例如，您可以使用計畫結構的

budget_結構體 ID

做為預算 Worktag 類型。

validationTypes

隨驗證結果傳回的驗證類型清單。 使用以下格式指定驗證類型的參考 ID︰

Worktags_REST_Validation_Type_ID={referenceID}

。 您可以在

Worktag REST 驗證類型

報告中取得支援驗證類型的參考 ID。範例︰

"validationTypes":[       
   {"id":"Worktags_REST_Validation_Type_ID=INACTIVE_WORKTAG_TYPES"}
]

如果您未指定

validationTypes

，端點會傳回所有驗證類型。

Worktag

用於判斷驗證問題的異動 Worktag 清單。請指定 Worktag 的參考 ID。範例︰

"worktags": [
    { "id":"Cost_Center_Reference_ID=10000"},
    { "id":"Organization_Reference_ID=REGION-4-132"}
]

端點會驗證以下交易中的所有 Worktag︰

缺少必要的 Worktag 類型。
無效的 Worktag 組合。

參數不支援 Worktag 值的匯總。範例︰職系或成本中心階層。

限制

配置了「限定」值的 Worktag 類型清單。請指定限制值的參考 ID。範例︰使用交易公司做為限制，驗證成本中心是否適用於以下公司︰

"restrictions":[
   {"id":"Company_Reference_ID=COMPANY-10-209"}
]

allowBuiltInWorktags

如果

true

，則此要求包含無法在

taggableConfiguration

的

「維護 Worktag 用途」

報告中將這些內建 Worktag 類型配置為允許的 Worktag 類型。內建 Worktag 是不可配置的 Worktag 類型，但可用於驗證用途。 範例︰供應商發票中的供應商。

success
- 指出申請中的有效 Worktag。
error
- 指出要求中的 Worktag 無效。 回應也會包含驗證問題或錯誤訊息。

成本中心
10000 CEO 辦公室
地區
- 跨亞歐文 - 中部非洲 (非作用中)
。

費用報告的配置︰
不允許非作用中的
區域
「」。
有必要的
「業務單位」
。
不允許 Worktag 類型
「成本中心」
和
「資金」
。
未啟用 Worktag 類型優先順序。

POST /validateWorktags

{
    "taggableConfiguration":{"id":"Taggable_Type_ID=EXPENSE_REPORT"},
    "worktags": [
        {"id":"Cost_Center_Reference_ID=10000"},
        { "id":"Organization_Reference_ID=REGION-4-132"}
    ]
}

{
  "missingRequiredWorktagTypesAfterDefaulting": [
    {
      "descriptor": "Business Unit",
      "id": "babec3e40ccf4a27b5b771d138289bbb"
    }
  ],
  "missingRequiredWorktagTypesForTaggableConfig": [
    {
      "descriptor": "Business Unit",
      "id": "babec3e40ccf4a27b5b771d138289bbb"
    }
  ],
  "nonAllowedWorktagTypesForTaggableConfig": [
    {
      "descriptor": "Cost Center",
      "id": "dc123302446c11de98360015c5e6daf6"
    }
  ],
  "nonAllowedInactiveWorktagValues": [
    {
      "descriptor": "Trans AA - Central Africa (inactive)",
      "id": "5b8348a2df5448b0bafea0563dc42eb5"
    }
  ],
  "status": "error"
}

成本中心
10000 CEO 辦公室
為
AMU 分攤費用
提供資金。
專案
- 重塑機動性
。
分區
CPG -
。
公司名稱
Global Modern Services, Inc (印尼)
。

費用報告的配置允許在要求中傳送的 Worktag 類型 (屬於 Worktag 類型)︰
成本中心
10000 首席執行官辦公室
︰
限於公司
200.1 Global Modern Services (K-K)(日本)
。
有
在交易
「捐贈」
和
「活動」
中必須指定的交易。
僅允許「為
FH01 AMU 提供資金」
和「專案
︰ACME 專案」
。
分區
CPG
︰
僅允許
為 F03.1 AMU 一般工廠資金
準備金。
在交易
補助金
中為「」為必要條件。
未啟用 Worktag 類型優先順序。

POST /validateWorktags

{
    "taggableConfiguration":{"id":"Taggable_Type_ID=EXPENSE_REPORT"},
    "restrictions":[
        {"id":"Company_Reference_ID=COMPANY-10-209"}
    ],
    "worktags": [
        {"id":"Cost_Center_Reference_ID=10000"},
        { "id":"Fund_ID=AMU Cost Share Fund"},
        { "id":"Project_ID=TRANSFORM_Reinventing_Mobility"},
        { "id":"Organization_Reference_ID=CPG"}
    ]
}

{
  "invalidRestrictionsForWorktags": [
    {
      "invalidRestrictedToValues": [
        {
          "descriptor": "200.10 PT Global Modern Services, Inc (Indonesia)",
          "id": "cfdefbbb550e4b37ae88ef0f6518041b"
        }
      ],
      "worktagWithRestrictedToValues": {
        "descriptor": "10000 Office of CEO",
        "id": "3b122818d7934d1c8c663ddbe1937819"
      }
    }
  ],
  "missingRequiredWorktagTypesForWorktags": [
    {
      "missingWorktagTypes": [
        {
          "descriptor": "Campaign",
          "id": "dc1234e2446c11de98360015c5e6daf6"
        },
        {
          "descriptor": "Gift",
          "id": "d2e0bdb657da45edadd7cd371d24a13e"
        }
      ],
      "worktagWithRequiredWorktags": {
        "descriptor": "10000 Office of CEO",
        "id": "3b122818d7934d1c8c663ddbe1937819"
      }
    },
    {
      "missingWorktagTypes": [
        {
          "descriptor": "Grant",
          "id": "ea50fe2ba95b453086f8c9616473a1e5"
        }
      ],
      "worktagWithRequiredWorktags": {
        "descriptor": "CPG",
        "id": "1fcf0b79747a43d1a4de334e0c214b1b"
      }
    }
  ],
  "status": "error",
  "invalidWorktagCombinations": [
    {
      "worktagWithAllowedValues": {
        "descriptor": "10000 Office of CEO",
        "id": "3b122818d7934d1c8c663ddbe1937819"
      },
      "invalidWorktagValues": [
        {
          "descriptor": "AMU Cost Share Fund",
          "id": "32b25c2287a6101bebc1a79b7c8a034d"
        },
        {
          "descriptor": "Mobilizing the Enterprise",
          "id": "4fba36e75dce4cf9bf0c386f15dc18b2"
        }
      ]
    },
    {
      "worktagWithAllowedValues": {
        "descriptor": "CPG",
        "id": "1fcf0b79747a43d1a4de334e0c214b1b"
      },
      "invalidWorktagValues": [
        {
          "descriptor": "AMU Cost Share Fund",
          "id": "32b25c2287a6101bebc1a79b7c8a034d"
        }
      ]
    }
  ]
}

專案
動員中
。
專案計畫階段 2
定義企業 的結構
。

POST /validateWorktags

{
    "taggableConfiguration":{"id":"Taggable_Type_ID=EXPENSE_REPORT"},
    "worktags": [
        {"id":"Project_ID=TRANSFORM_Reinventing_Mobility"},
        {"id":"Project_Plan_ID=PROJECT_PLAN_PHASE-4-8"}
    ]
}

{
  "onlyOneProjectOrPhaseOrTaskAllowed": "Only one of ~Project~, ~Project Phase~ or ~Project Task~ worktag value can be specified.",
  "status": "error"
}

成本中心
10000 CEO 辦公室
地區
- 跨亞歐文 - 中部非洲 (非作用中)
。

此費用報告配置不允許︰
非作用中的
區域
︰。
成本中心
和
資金
Worktag 類型

POST /validateWorktags

{
    "validationTypes":[       
        {"id":"Worktags_REST_Validation_Type_ID=INACTIVE_WORKTAG_TYPES"}
    ],
    "taggableConfiguration":{"id":"Taggable_Type_ID=EXPENSE_REPORT"},
    "worktags": [
        { "id":"Cost_Center_Reference_ID=10000"},
        { "id":"Organization_Reference_ID=REGION-4-132"}
    ]
}

{
  "nonAllowedInactiveWorktagValues": [
    {
      "descriptor": "Trans AA - Central Africa (inactive)",
      "id": "5b8348a2df5448b0bafea0563dc42eb5"
    }
  ],
  "status": "error"
}

補助金 -
植物研究補助金 1
．

供應商發票的配置需要︰
授予
。
成本中心
。
「
植物研究補助金 1」的
預設成本中心為
10000，CEO 辦公室為
。
已啟用 Worktag 類型優先順序，
「授予」
是其中一種 Worktag 類型。

POST /validateWorktags

{
    "validationTypes":[       
        {"id":"Worktags_REST_Validation_Type_ID=REQUIRED_WORKTAG_TYPES_AFTER_DEFAULTING"}
    ],
    "taggableConfiguration":{"id":"Taggable_Type_ID=SUPPLIER_INVOICE"},
    "worktags": [
        { "id":"Grant_ID=AGRT-0021"}
    ]
}

{
  "status": "success"
}