EOTF_XREF Service
This section lists the service operations available for cross references:
EOTF_XREF_ADD
EOTF_XREF_LINK
EOTF_XREF_UPDATE
EOTF_XREF_DELETE
EOTF_XREF_LOOKUP
EOTF_XREF_IMPORT.v2
EOTF_XREF_IMPORT.v1
Use this service operation to add values to a cross-reference map.
Alias: add_xref_value
Type: Synchronous
Request Message: EOTF_XREF_ADD_REQ.V1
This is an example of the soap body for the request:
<soapenv:Body>
<xref:xrefAddValue>
<xref:mapname>?</xref:mapname>
<!--2 or more repetitions:-->
<xref:Values>
<xref:domain>?</xref:domain>
<!--1 or more repetitions:-->
<xref:element name="?"/>
</xref:Values>
<xref:Values>
<xref:domain>?</xref:domain>
<!--1 or more repetitions:-->
<xref:element name="?"/>
</xref:Values>
</xref:xrefAddValue>
</soapenv:Body>
Element Name |
Description |
---|---|
mapname |
The name of the cross-reference map to add values to. |
Values |
This element holds the cross-reference elements and values to be populated. |
domain |
The name of the domain the elements are a part of. |
element |
This represents an element and its value. |
Response Message: EOTF_XREF_RESPONSE.V1
Element Name |
Description |
---|---|
status |
The status of the operation. Returns Success or Exception. |
reason |
If there is an exception, the reason will be returned. |
responseValues |
The values returned for the lookup operation. |
domain |
The name of the target domain provided on the lookup request. |
element |
Represents an element in the target domain and its value. |
Use this service operation to link values to a cross-reference map.
Alias: link_xref_value
Type: Synchronous
Request Message: EOTF_XREF_LINK_REQ.V1
This is an example of the soap body for the request:
<soapenv:Body>
<xref:xrefLinkValue>
<xref:mapname>?</xref:mapname>
<xref:ReferenceValues>
<xref:domain>?</xref:domain>
<!--1 or more repetitions:-->
<xref:element name="?"/>
</xref:ReferenceValues>
<!--1 or more repetitions:-->
<xref:TargetValues>
<xref:domain>?</xref:domain>
<!--1 or more repetitions:-->
<xref:element name="?"/>
</xref:TargetValues>
</xref:xrefLinkValue>
</soapenv:Body>
Element Name |
Description |
---|---|
mapname |
The name of the cross-reference map to add values to. |
ReferenceValues |
This element holds the existing elements and values in a cross-reference to link target values with. |
domain |
The name of the domain the reference elements are a part of. |
element |
This represents a cross-reference element and its value. |
targetValues |
This element holds the cross-reference elements and values to be added. |
domain |
The name of the domain the target elements are a part of. |
element |
This represents a cross-reference element and its value. |
Response Message: EOTF_XREF_RESPONSE.V1
Element Name |
Description |
---|---|
status |
The status of the operation. Returns Success or Exception. |
reason |
If there is an exception, the reason will be returned. |
responseValues |
The values returned for the lookup operation. |
domain |
The name of the target domain provided on the lookup request. |
element |
Represents an element in the target domain and its value. |
Use this service operation to update values in a cross-reference map.
Alias: update_xref_value
Type: Synchronous
Request Message: EOTF_XREF_UPDATE_REQ.V1
This is an example of the soap body for the request:
<soapenv:Body>
<xref:xrefUpdateValue>
<xref:mapname>?</xref:mapname>
<xref:ReferenceValues>
<xref:domain>?</xref:domain>
<!--1 or more repetitions:-->
<xref:element name="?"/>
</xref:ReferenceValues>
<!--1 or more repetitions:-->
<xref:TargetValues>
<xref:domain>?</xref:domain>
<!--1 or more repetitions:-->
<xref:element name="?"/>
</xref:TargetValues>
</xref:xrefUpdateValue>
</soapenv:Body>
Element Name |
Description |
---|---|
mapname |
The name of the cross-reference map to update values to. |
ReferenceValues |
This element holds the existing cross-reference elements and values to locate the row to be updated. |
domain |
The name of the domain the reference elements are a part of. |
element |
This represents a cross-reference element and its value. |
targetValues |
This element holds the cross-reference elements to be updated and the new values. |
domain |
The name of the domain the target elements are a part of. |
element |
This represents a cross-reference element and its value. |
Response Message: EOTF_XREF_RESPONSE.V1
Element Name |
Description |
---|---|
status |
The status of the operation. Returns Success or Exception. |
reason |
If there is an exception, the reason will be returned. |
responseValues |
The values returned for the lookup operation. |
domain |
The name of the target domain provided on the lookup request. |
element |
Represents an element in the target domain and its value. |
Use this service operation to delete values from a cross-reference map.
Alias: delete_xref_value
Type: Synchronous
Request Message: EOTF_XREF_DELETE_REQ.V1
This is an example of the soap body for the request:
<soapenv:Body>
<xref:xrefDeleteValue>
<xref:mapname>?</xref:mapname>
<!--2 or more repetitions:-->
<xref:Values>
<xref:domain>?</xref:domain>
<!--1 or more repetitions:-->
<xref:element name="?"/>
</xref:Values>
<xref:Values>
<xref:domain>?</xref:domain>
<!--1 or more repetitions:-->
<xref:element name="?"/>
</xref:Values>
</xref:xrefDeleteValue>
</soapenv:Body>
Element Name |
Description |
---|---|
mapname |
The name of the cross-reference map to delete values from. |
Values |
This element holds the cross-reference elements and values to be deleted. |
domain |
The name of the domain the elements are a part of. |
element |
This represents an element and its value. |
Response Message: EOTF_XREF_RESPONSE.V1
Element Name |
Description |
---|---|
status |
The status of the operation. Returns Success or Exception. |
reason |
If there is an exception, the reason will be returned. |
responseValues |
No response values are returned. |
Use this service operation to lookup values from a cross-reference map.
Alias: lookup_xref_value
Type: Synchronous
EOTF_XREF_LOOKUP_REQ.V1
This is an example of the soap body for the request:
<soapenv:Body>
<xref:xrefLookupValue needFault="true">
<xref:mapname>?</xref:mapname>
<xref:Values>
<xref:domain>?</xref:domain>
<!--1 or more repetitions:-->
<xref:element name="?">?</xref:element>
</xref:Values>
<xref:targetDomain>?</xref:targetDomain>
</xref:xrefLookupValue>
</soapenv:Body>
Element Name |
Description |
---|---|
mapname |
The name of the cross-reference map to lookup values in. |
Values |
This element holds the cross-reference elements and values to lookup. |
domain |
The name of the domain the reference elements are a part of. |
element |
This represents a cross-reference element and its value. |
targetDomain |
The name of the domain the lookup request should return elements and values for. |
Response Message: EOTF_XREF_RESPONSE.V1
Element Name |
Description |
---|---|
status |
The status of the operation. Returns Success or Exception. |
reason |
If there is an exception, the reason will be returned. |
responseValues |
The values returned for the lookup operation. |
domain |
The name of the target domain provided on the lookup request. |
element |
Represents an element in the target domain and its value. |
Use this service operation to import a cross-reference map definition and values in using PeopleSoft schema.
Alias: xref
Type: Asynchronous - One Way
Default: Yes
Request Message: EOTF_XREF.V2
This is an example of the soap body for the request:
<soapenv:Body>
<xref:xref>
<xref:name>?</xref:name>
<!--Optional:-->
<xref:description>?</xref:description>
<!--Optional:-->
<xref:comments>?</xref:comments>
<xref:elements>
<!--2 or more repetitions:-->
<xref:element name="?" order="?" dataType="string" dataLength="?" isCommon="false"/>
<xref:element name="?" order="?" dataType="string" dataLength="?" isCommon="false"/>
</xref:elements>
<xref:domains>
<!--1 or more repetitions:-->
<xref:domain name="?">
<!--1 or more repetitions:-->
<xref:element name="?"/>
</xref:domain>
</xref:domains>
<!--Optional:-->
<xref:rows>
<!--1 or more repetitions:-->
<xref:row>
<!--2 or more repetitions:-->
<xref:cell>?</xref:cell>
<xref:cell>?</xref:cell>
</xref:row>
</xref:rows>
</xref:xref>
</soapenv:Body>
Element Name |
Description |
---|---|
description |
The cross-reference description. Optional |
comments |
Comments about the cross-reference. Optional |
elements |
This element holds the cross-reference element list. |
element |
Represents a cross-reference element. |
domains |
This elements holds the cross-reference domain list. |
domain |
This element represents a domain in a cross-reference map. |
element |
This represents an element in the cross-reference domain. |
rows |
This represents all the rows of data in the cross-reference map. |
row |
Each cross-reference row of values. |
cell |
This is the value for this row and the for each element in the same order as defined in elements. |
Use this service opertaion to import a cross-reference map definition and values in using PeopleSoft schema.
Alias: xref
Type: Asynchronous - One Way
Default: No
Transform: To v2
Request Message: EOTF_XREF.V1
This is an example of the soap body for the request:
<soapenv:Body>
<xref:xref>
<xref:table name="?">
<!--Optional:-->
<xref:description>?</xref:description>
<!--Optional:-->
<xref:columns>
<!--1 or more repetitions:-->
<xref:column name="?"/>
</xref:columns>
<!--Optional:-->
<xref:rows>
<!--1 or more repetitions:-->
<xref:row>
<!--1 or more repetitions:-->
<xref:cell colName="?"/>
</xref:row>
</xref:rows>
</xref:table>
</xref:xref>
</soapenv:Body>
Element Name |
Description |
---|---|
table |
This element hold the table elements. |
description |
The DVM description. Optional |
columns |
This element holds the DVM's column list. |
column |
Represents a DVM column. |
rows |
This represents all the rows of data in the DVM. |
row |
Each DVM row of values. |
cell |
This is the value for this row and the for each column in the same order as defined in columns. |