ドキュメントAEMDynamic Media Image Production System API

addCompany addcompany

最終更新日： 2024年7月22日

作成対象：

  • Developer
  • Admin

会社をシステムに追加します。

システムに追加する会社の名前を送信し、オプションで会社の有効期限が切れるかどうかを送信します。

この操作が呼び出されると、会社ハンドルと記述的フィールドを含むcompanyInfo タイプがシステムに取得されます。 要求された会社名が既にシステムに存在する場合は、ipsApiFaultがスローされます。

承認済みユーザータイプ section-ae926c7672984be79f6102748accab72

  • IpsAdmin
  • TrialSiteAdmin
  • ImagePortalAdmin

パラメーター section-c64a21b72585447880760db9e7a12ccb

入力（addCompanyParam）

名前
種類
必須
説明
companyName
xsd:string
はい
追加する会社の名前。
の有効期限
xsd:dateTime
いいえ
会社の有効期限。 このフィールドのリクエストをタイムゾーンに指定します。 タイムゾーンは中央の時間に調整されます。

出力（addCompanyReturn）

名前
種類
必須
説明
companyInfo
xsd:string
はい
新しい会社の名前、ルートパス、有効期限、および時刻に対して処理します。

例 section-4c8f1bb40d154c77a7b410468206e52b

この例では、会社をIPS システムに追加するためのリクエストと、他の操作を実行するために必要な、追加された会社に関する情報の詳細を示す応答を示します。

リクエスト

<ns1:addCompanyParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:companyName>Planetary</ns1:companyName>
</ns1:addCompanyParam>

応答

<ns1:addCompanyReturn xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:companyInfo>
      <ns1:companyHandle>137</ns1:companyHandle>
      <ns1:name>Planetary</ns1:name>
      <ns1:rootPath>Planetary/</ns1:rootPath>
      <ns1:expires>2101-01-31T23:00:00.030Z</ns1:expires>
   </ns1:companyInfo>
</ns1:addCompanyReturn>
recommendation-more-help
dynamic-media-developer-resources-help-aem-ips-api