Jump to

• Request
• Response

Create a person relationship

post

/fscmRestApi/resources/11.13.18.05/hedPersonRelationships

Request

Header Parameters

• Metadata-Context: string
  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: string
  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: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ObjectPersonPartyId: integer (int64)
  Title: Object Person Party ID

  The object person party ID.
• RelationshipCode: string
  Title: Relationship Code

  Maximum Length: 30

  The code of the relationship.
• RelationshipTypeCode: string
  Title: Relationship Type

  Maximum Length: 30

  The person relationship type code. A list of accepted values is defined in the lookup type HZ_RELATIONSHIP_TYPE.
• SubjectPersonPartyId: integer (int64)
  Title: Subject Person Party ID

  The subject person party ID.

{
    "type":"object",
    "properties":{
        "RelationshipTypeCode":{
            "title":"Relationship Type",
            "maxLength":30,
            "type":"string",
            "description":"The person relationship type code. A list of accepted values is defined in the lookup type HZ_RELATIONSHIP_TYPE.",
            "nullable":false
        },
        "ObjectPersonPartyId":{
            "title":"Object Person Party ID",
            "type":"integer",
            "description":"The object person party ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SubjectPersonPartyId":{
            "title":"Subject Person Party ID",
            "type":"integer",
            "description":"The subject person party ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RelationshipCode":{
            "title":"Relationship Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the relationship.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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 : hedPersonRelationships-item-response

Type: object

Show Source

• EndDate: string (date)
  Title: To Date

  Read Only: true

  The end date of the relationship.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectPersonEmailAddress: string
  Title: Email

  Read Only: true

  Maximum Length: 320

  The object person email address.
• ObjectPersonFirstName: string
  Title: First Name

  Read Only: true

  Maximum Length: 150

  The object person first name.
• ObjectPersonFullName: string
  Title: Full Name

  Read Only: true

  Maximum Length: 360

  The object person full name.
• ObjectPersonLastName: string
  Title: Last Name

  Read Only: true

  Maximum Length: 150

  The object person last name.
• ObjectPersonMiddleName: string
  Title: Middle Name

  Read Only: true

  Maximum Length: 60

  The object person middle name.
• ObjectPersonPartyId: integer (int64)
  Title: Object Person Party ID

  The object person party ID.
• RelationshipCode: string
  Title: Relationship Code

  Maximum Length: 30

  The code of the relationship.
• RelationshipId: integer (int64)
  Title: Relationship ID

  Read Only: true

  The relationship ID.
• RelationshipMeaning: string
  Title: Relationship Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the relationship. A list of accepted values is defined in the lookup type PARTY_RELATIONS_TYPE.
• RelationshipTypeCode: string
  Title: Relationship Type

  Maximum Length: 30

  The person relationship type code. A list of accepted values is defined in the lookup type HZ_RELATIONSHIP_TYPE.
• RelationshipTypeMeaning: string
  Title: Relationship Type Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the relationship type. A list of accepted values is defined in the lookup type HZ_RELATIONSHIP_TYPE.
• StartDate: string (date)
  Title: From Date

  Read Only: true

  The start date of the relationship.
• SubjectPersonEmailAddress: string
  Title: Email

  Read Only: true

  Maximum Length: 320

  The subject person email address.
• SubjectPersonFirstName: string
  Title: First Name

  Read Only: true

  Maximum Length: 150

  The subject person first name.
• SubjectPersonFullName: string
  Title: Full Name

  Read Only: true

  Maximum Length: 360

  The subject person full name.
• SubjectPersonLastName: string
  Title: Last Name

  Read Only: true

  Maximum Length: 150

  The subject person last name.
• SubjectPersonMiddleName: string
  Title: Middle Name

  Read Only: true

  Maximum Length: 60

  The subject person middle name.
• SubjectPersonPartyId: integer (int64)
  Title: Subject Person Party ID

  The subject person party ID.

{
    "type":"object",
    "properties":{
        "RelationshipTypeMeaning":{
            "title":"Relationship Type Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the relationship type. A list of accepted values is defined in the lookup type HZ_RELATIONSHIP_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipMeaning":{
            "title":"Relationship Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the relationship. A list of accepted values is defined in the lookup type PARTY_RELATIONS_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectPersonEmailAddress":{
            "title":"Email",
            "maxLength":320,
            "type":"string",
            "description":"The object person email address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "ObjectPersonPartyId":{
            "title":"Object Person Party ID",
            "type":"integer",
            "description":"The object person party ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectPersonLastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The object person last name.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            },
            "x-queryable":true
        },
        "SubjectPersonPartyId":{
            "title":"Subject Person Party ID",
            "type":"integer",
            "description":"The subject person party ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"To Date",
            "type":"string",
            "description":"The end date of the relationship.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DefaultValue":"FUTURE_DATE"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"From Date",
            "type":"string",
            "description":"The start date of the relationship.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipTypeCode":{
            "title":"Relationship Type",
            "maxLength":30,
            "type":"string",
            "description":"The person relationship type code. A list of accepted values is defined in the lookup type HZ_RELATIONSHIP_TYPE.",
            "nullable":false,
            "x-queryable":true
        },
        "SubjectPersonFirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"The subject person first name.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            },
            "x-queryable":true
        },
        "SubjectPersonFullName":{
            "title":"Full Name",
            "maxLength":360,
            "type":"string",
            "description":"The subject person full name.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipId":{
            "title":"Relationship ID",
            "type":"integer",
            "description":"The relationship ID.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SubjectPersonEmailAddress":{
            "title":"Email",
            "maxLength":320,
            "type":"string",
            "description":"The subject person email address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "RelationshipCode":{
            "title":"Relationship Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the relationship.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ObjectPersonMiddleName":{
            "title":"Middle Name",
            "maxLength":60,
            "type":"string",
            "description":"The object person middle name.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonMiddleName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Middle Name"
            },
            "x-queryable":true
        },
        "SubjectPersonMiddleName":{
            "title":"Middle Name",
            "maxLength":60,
            "type":"string",
            "description":"The subject person middle name.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonMiddleName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Middle Name"
            },
            "x-queryable":true
        },
        "SubjectPersonLastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The subject person last name.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            },
            "x-queryable":true
        },
        "ObjectPersonFirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"The object person first name.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            },
            "x-queryable":true
        },
        "ObjectPersonFullName":{
            "title":"Full Name",
            "maxLength":360,
            "type":"string",
            "description":"The object person full name.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

hedRelationshipTypesLOV

Operation: /fscmRestApi/resources/11.13.18.05/hedRelationshipTypesLOV

Parameters:

• finder: PersonRelationshipTypeFinder%3BInUseRelationshipCode%3D{RelationshipCode}%2CInUseRelationshipTypeCode%3D{RelationshipTypeCode}

The following properties are defined on the LOV link relation:

• Source Attribute: RelationshipCode; Target Attribute: RelationshipCode
• Display Attribute: RelationshipMeaning

Back to Top