Get a person service hold
get
/fscmRestApi/resources/11.13.18.05/hedPersonServiceHolds/{PersonServiceHoldId}
Request
Path Parameters
-
PersonServiceHoldId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : hedPersonServiceHolds-item-response
Type:
Show Source
object
-
CommunicationTypeCode: string
Maximum Length:
30
Code for service hold communication type. A list of accepted values is defined in the lookup type ORA_HEY_SVC_HOLD_COMM_TYPE. -
CommunicationTypeMeaning: string
Read Only:
true
Maximum Length:80
Meaning for service hold communication type. A list of accepted values is defined in the lookup type ORA_HEY_SVC_HOLD_COMM_TYPE. -
DetailedMitigationSteps: string
Maximum Length:
600
Detailed steps defined for mitigating a service hold. -
EndDate: string
(date)
End date for the person service hold.
-
FullName: string
Title:
Name
Read Only:true
Maximum Length:360
The first and last name of the party displayed as a single string. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MitigationContactName: string
Title:
Name
Read Only:true
Maximum Length:360
Name for mitigation contact. -
MitigationContactPartyId: integer
(int64)
Unique identifier for mitigation contact.
-
MitigationDestinationCode: string
Maximum Length:
30
Code for an internal destination for service hold mitigation. -
MitigationDestinationName: string
Read Only:
true
Maximum Length:256
Name for an internal destination for service hold mitigation. -
MitigationSteps: string
Maximum Length:
100
Steps defined for mitigating a service hold. -
ModifiedDate: string
(date-time)
Read Only:
true
Last update date for the person service hold. -
PartyId: integer
(int64)
The unique identifier for the party. Party can be a person. For example, a person can be a party.
-
PersonServiceHoldId: integer
(int64)
Read Only:
true
The unique identifier assigned to a person service hold. -
Resolution: string
Maximum Length:
600
Resolution notes for resolving a service hold. -
ShowToRecipientFlag: boolean
Maximum Length:
1
Default Value:true
Indicates whether the person service hold is visible to the person. The default value is yes. -
StartDate: string
(date)
Start date for the person service hold.
-
StatusCode: string
Maximum Length:
30
Status code for the person service hold. A list of accepted values is defined in the lookup type ORA_TAG_ASSIGNMENT_STATUS_CODE. -
StatusMeaning: string
Read Only:
true
Maximum Length:80
Status meaning for the person service hold. A list of accepted values is defined in the lookup type ORA_TAG_ASSIGNMENT_STATUS_CODE. -
TagCode: string
Maximum Length:
30
Code for a tag. -
TagDescription: string
Read Only:
true
Maximum Length:240
Description for a tag. -
TagId: integer
(int64)
Identifier for a tag.
-
TagName: string
Read Only:
true
Maximum Length:64
Name for a tag.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- CommunicationTypeCodeLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupType%3DORA_HEY_SVC_HOLD_COMM_TYPE%2CLookupCode%3D{CommunicationTypeCode}
The following properties are defined on the LOV link relation:- Source Attribute: CommunicationTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- MitigationContactPartyIdLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: MitigationContactPartyId; Target Attribute: ContactPartyId
- Display Attribute: FullName
- statusCodesLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupType%3DORA_TAG_ASSIGNMENT_STATUS_CODE%2CLookupCode%3D{StatusCode}
The following properties are defined on the LOV link relation:- Source Attribute: StatusCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- tagCodesLOV
-
Parameters:
- finder:
ByTagTypeFinder%3BTagTypeCode%3DORA_HEY_SERVICE_HOLD
The following properties are defined on the LOV link relation:- Source Attribute: TagCode; Target Attribute: TagCode
- Display Attribute: TagName
- finder: