Jump to

• Request
• Response

Create a person service hold

post

/fscmRestApi/resources/11.13.18.05/hedPersonServiceHolds

Request

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.
• Upsert-Mode:
  When set to true, the server will perform an Upsert operation instead of a Create. In an Upsert operation the server attempts to find an existing resource that matches the payload. If found, the server updates the existing resource instead of creating a new one. If not found, or when set to false (the default), a Create is performed.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.
• DetailedMitigationSteps: string
  Maximum Length: 600

  Detailed steps defined for mitigating a service hold.
• EndDate: string (date)
  End date for the person service hold.
• MitigationContactPartyId: integer (int64)
  Unique identifier for mitigation contact.
• MitigationDestinationCode: string
  Maximum Length: 30

  Code for an internal destination for service hold mitigation.
• MitigationSteps: string
  Maximum Length: 100

  Steps defined for mitigating a service hold.
• PartyId: integer (int64)
  The unique identifier for the party. Party can be a person. For example, a person can be a party.
• 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.
• TagCode: string
  Maximum Length: 30

  Code for a tag.
• TagId: integer (int64)
  Identifier for a tag.

{
    "type":"object",
    "properties":{
        "MitigationDestinationCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code for an internal destination for service hold mitigation.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EndDate":{
            "type":"string",
            "description":"End date for the person service hold.",
            "format":"date",
            "nullable":true
        },
        "StatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Status code for the person service hold. A list of accepted values is defined in the lookup type ORA_TAG_ASSIGNMENT_STATUS_CODE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DetailedMitigationSteps":{
            "maxLength":"600",
            "type":"string",
            "description":"Detailed steps defined for mitigating a service hold.",
            "nullable":true,
            "x-queryable":false
        },
        "StartDate":{
            "type":"string",
            "description":"Start date for the person service hold.",
            "format":"date",
            "nullable":true
        },
        "MitigationSteps":{
            "maxLength":"100",
            "type":"string",
            "description":"Steps defined for mitigating a service hold.",
            "nullable":false,
            "x-queryable":false
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier for the party. Party can be a person. For example, a person can be a party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ShowToRecipientFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the person service hold is visible to the person. The default value is yes.",
            "nullable":false,
            "default":true
        },
        "TagId":{
            "type":"integer",
            "description":"Identifier for a tag.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CommunicationTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code for service hold communication type. A list of accepted values is defined in the lookup type ORA_HEY_SVC_HOLD_COMM_TYPE.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "MitigationContactPartyId":{
            "type":"integer",
            "description":"Unique identifier for mitigation contact.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "TagCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code for a tag.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Resolution":{
            "maxLength":"600",
            "type":"string",
            "description":"Resolution notes for resolving a service hold.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : hedPersonServiceHolds-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "MitigationDestinationName":{
            "maxLength":"256",
            "type":"string",
            "description":"Name for an internal destination for service hold mitigation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "TagName":{
            "maxLength":"64",
            "type":"string",
            "description":"Name for a tag.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CommunicationTypeMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Meaning for service hold communication type. A list of accepted values is defined in the lookup type ORA_HEY_SVC_HOLD_COMM_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "MitigationContactName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"Name for mitigation contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "TagDescription":{
            "maxLength":"240",
            "type":"string",
            "description":"Description for a tag.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonServiceHoldId":{
            "type":"integer",
            "description":"The unique identifier assigned to a person service hold.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "MitigationDestinationCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code for an internal destination for service hold mitigation.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ModifiedDate":{
            "type":"string",
            "description":"Last update date for the person service hold.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"End date for the person service hold.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Status code for the person service hold. A list of accepted values is defined in the lookup type ORA_TAG_ASSIGNMENT_STATUS_CODE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DetailedMitigationSteps":{
            "maxLength":"600",
            "type":"string",
            "description":"Detailed steps defined for mitigating a service hold.",
            "nullable":true,
            "x-queryable":false
        },
        "StartDate":{
            "type":"string",
            "description":"Start date for the person service hold.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "MitigationSteps":{
            "maxLength":"100",
            "type":"string",
            "description":"Steps defined for mitigating a service hold.",
            "nullable":false,
            "x-queryable":false
        },
        "StatusMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Status meaning for the person service hold. A list of accepted values is defined in the lookup type ORA_TAG_ASSIGNMENT_STATUS_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier for the party. Party can be a person. For example, a person can be a party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ShowToRecipientFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the person service hold is visible to the person. The default value is yes.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "FullName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The first and last name of the party displayed as a single string.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TagId":{
            "type":"integer",
            "description":"Identifier for a tag.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CommunicationTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code for service hold communication type. A list of accepted values is defined in the lookup type ORA_HEY_SVC_HOLD_COMM_TYPE.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "MitigationContactPartyId":{
            "type":"integer",
            "description":"Unique identifier for mitigation contact.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TagCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code for a tag.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Resolution":{
            "maxLength":"600",
            "type":"string",
            "description":"Resolution notes for resolving a service hold.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

CommunicationTypeCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

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

MitigationContactPartyIdLOV

Operation: /fscmRestApi/resources/11.13.18.05/hedOrganizationContacts

The following properties are defined on the LOV link relation:

• Source Attribute: MitigationContactPartyId; Target Attribute: ContactPartyId
• Display Attribute: FullName

statusCodesLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

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

tagCodesLOV

Operation: /fscmRestApi/resources/11.13.18.05/hedTagsLOV

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

Back to Top