Among the commands that operate contract information, the following three types of commands use XML:
fscsm_contract create (contract information registration)
fscsm_contract modify (contract information modification)
fscsm_contract export (contract information output)
The formats of the XML files corresponding to each of these commands are explained below.
Elements of XML must be as the following stratum structure:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <contracts> <contract rId=" Resource ID of the Contact"> <comment>Description</comment> <contractId>Contract ID</contractId> <contractName>Contract Name</contractName> <contractNo>Contract Number</contractNo> <contractPeriod>Contract Period</contractPeriod> <contractorContact>Contractor Contract Information</contractorContact> <contractorName>Contractor</contractorName> <maintenanceId>Management Service ID</maintenanceId> <vendorId>Vendor ID</vendorId> <vendorPortalId>Vendor Portal ID</vendorPortalId> <usePermission>User Agreement</usePermission> </contract> </contracts> |
Element (Name or Attribute) | Omission or Display | Acceptable Value in Registration or Modificaiton | ||
Registration | Modification | Output | ||
Resource ID of the Contact (contract rId) | × | × | ○ | - |
Description (comment) | △ | △ | ○ | Specify a character string containing 0 to 256 characters. |
Contract ID (contractId) | ○ | ○ *1 | ○ | Specify a character string beginning with an alphanumeric character and containing 1 to 32 alphanumeric characters, underscores ("_"), hyphens ("-"), and periods ("."). The ID must not overlap other user ID. Specify a unique value. |
Contract Name (contractName) | ○ | ○ | ○ | Specify a character string containing 1 to 64 characters. |
Contract Number (contractNo) | △ | △ | ○ | Specify a character string containing 0 to 64 characters. |
Contract Period (contractPeriod) | △ | △ | ○ | Specify a character string containing 0 to 256 characters. |
Contractor Contract Information (contractorContact) | △ | △ | ○ | Specify a character string containing 0 to 256 characters as the contact phone number or the e-mail address. |
Contractor (contractorName) | △ | △ | ○ | Specify a character string containing 0 to 64 characters. |
Management Service ID (maintenanceId) | △ | △ | ○ | Specify a character string containing 0 to 64 characters. However specifying the ID is unnecessary if ROR or no cloud providers are specified in the vendor information. |
Vendor ID (vendorId) | ○ | ○ *1 | ○ | Specify the vendor ID written in the vendor information. |
Vendor Portal ID (vendorPortalId) | △ | △ | ○ | Specify a character string containing 0 to 64 characters. However specifying the ID is unnecessary if ROR or no cloud providers are specified in the vendor information. |
User Agreement (usePermission) | △ | △ *2 | ○ | Specify a character string containing 0 to 1024 characters. |
Refer to the following about symbols of the "Omission or Display" column.
○: Entry is mandatory, or element is output.
△: Omission is permitted.
×: Specifying is not permitted, or element is not output.
*1: Modifying is not permitted.
*2: The value registered before is deleted if the element is omitted in the XML during executing contract modification command.