Jump to

• Request
• Response

Create a relationship type

post

/fscmRestApi/resources/11.13.18.05/hedRelationshipTypes

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

• EnabledFlag: boolean
  Title: Relationship Indicator

  Maximum Length: 1

  Default Value: false

  The relationship type status. The default value for relationship type is false. If the value is false, the relationship type is inactive and if it's true, it will be active.
• ObjectTypeCode: string
  Title: Object Type Code

  Maximum Length: 30

  The object type code of relationship.
• RelationshipCode: string
  Title: Relationship Code

  Maximum Length: 30

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

  Maximum Length: 30

  The code of relationship type.
• SubjectTypeCode: string
  Title: Subject Type Code

  Maximum Length: 30

  The subject type code of relationship.

{
    "type":"object",
    "properties":{
        "ObjectTypeCode":{
            "title":"Object Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The object type code of relationship.",
            "nullable":false
        },
        "RelationshipTypeCode":{
            "title":"Relationship Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of relationship type.",
            "nullable":false
        },
        "EnabledFlag":{
            "title":"Relationship Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"The relationship type status. The default value for relationship type is false. If the value is false, the relationship type is inactive and if it's true, it will be active.",
            "nullable":false,
            "default":false
        },
        "SubjectTypeCode":{
            "title":"Subject Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The subject type code of relationship.",
            "nullable":false
        },
        "RelationshipCode":{
            "title":"Relationship Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of relationship.",
            "nullable":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 : hedRelationshipTypes-item-response

Type: object

Show Source

• EnabledFlag: boolean
  Title: Relationship Indicator

  Maximum Length: 1

  Default Value: false

  The relationship type status. The default value for relationship type is false. If the value is false, the relationship type is inactive and if it's true, it will be active.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectTypeCode: string
  Title: Object Type Code

  Maximum Length: 30

  The object type code of relationship.
• ObjectTypeMeaning: string
  Title: Object Type Meaning

  Read Only: true

  Maximum Length: 80

  The object type meaning of relationship. A list of accepted values is defined in the lookup type PARTY_TYPE.
• RelationshipCode: string
  Title: Relationship Code

  Maximum Length: 30

  The code of relationship.
• RelationshipMeaning: string
  Title: Relationship Meaning

  Read Only: true

  Maximum Length: 80

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

  Maximum Length: 30

  The code of relationship type.
• RelationshipTypeId: integer (int64)
  Title: Relationship Type ID

  Read Only: true

  The ID of relationship type.
• RelationshipTypeMeaning: string
  Title: Relationship Type Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of relationship type. A list of accepted values is defined in the lookup type HZ_RELATIONSHIP_TYPE.
• SubjectTypeCode: string
  Title: Subject Type Code

  Maximum Length: 30

  The subject type code of relationship.
• SubjectTypeMeaning: string
  Title: Subject Type Meaning

  Read Only: true

  Maximum Length: 80

  The subject type meaning of relationship. A list of accepted values is defined in the lookup type PARTY_TYPE.

{
    "type":"object",
    "properties":{
        "RelationshipTypeMeaning":{
            "title":"Relationship Type Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of 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 relationship. A list of accepted values is defined in the lookup type PARTY_RELATIONS_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubjectTypeMeaning":{
            "title":"Subject Type Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The subject type meaning of relationship. A list of accepted values is defined in the lookup type PARTY_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipTypeCode":{
            "title":"Relationship Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of relationship type.",
            "nullable":false,
            "x-queryable":true
        },
        "RelationshipTypeId":{
            "title":"Relationship Type ID",
            "type":"integer",
            "description":"The ID of relationship type.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RelationshipCode":{
            "title":"Relationship Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of relationship.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectTypeMeaning":{
            "title":"Object Type Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The object type meaning of relationship. A list of accepted values is defined in the lookup type PARTY_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectTypeCode":{
            "title":"Object Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The object type code of relationship.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "title":"Relationship Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"The relationship type status. The default value for relationship type is false. If the value is false, the relationship type is inactive and if it's true, it will be active.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "SubjectTypeCode":{
            "title":"Subject Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The subject type code of relationship.",
            "nullable":false,
            "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."
        }
    }
}

Back to Top