Jump to

• Request
• Response

Create relationships

post

/fscmRestApi/resources/11.13.18.05/genealogyRelationships

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActiveEndDate: string (date-time)
  Date when a genealogy relationship is no longer active.
• ChildGenealogyInstanceId: integer (int64)
  Value that uniquely identifies a child genealogy object instance.
• ParentGenealogyInstanceId: integer (int64)
  Value that uniquely identifies a parent genealogy object instance.
• RelationshipId: integer (int64)
  Value that uniquely identifies the relationship between an instance of a parent genealogy object and an instance of a child genealogy object.

{
    "type":"object",
    "properties":{
        "ChildGenealogyInstanceId":{
            "type":"integer",
            "description":"Value that uniquely identifies a child genealogy object instance.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ParentGenealogyInstanceId":{
            "type":"integer",
            "description":"Value that uniquely identifies a parent genealogy object instance.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RelationshipId":{
            "type":"integer",
            "description":"Value that uniquely identifies the relationship between an instance of a parent genealogy object and an instance of a child genealogy object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ActiveEndDate":{
            "type":"string",
            "description":"Date when a genealogy relationship is no longer active.",
            "format":"date-time",
            "nullable":true
        }
    }
}

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

Type: object

Show Source

• ActiveEndDate: string (date-time)
  Date when a genealogy relationship is no longer active.
• ChildGenealogyInstanceId: integer (int64)
  Value that uniquely identifies a child genealogy object instance.
• ChildItemId: integer (int64)
  Title: Item Number

  Read Only: true

  Value that uniquely identifies the item of the child genealogy object instance. Either item identifier or item number can be used during the POST, PATCH, or GET actions.
• ChildItemNumber: string
  Read Only: true

  Maximum Length: 300

  Number that uniquely identifies the item of the child genealogy object instance. Either item identifier or item number can be used during the POST, PATCH or GET actions.
• ChildLotNumber: string
  Read Only: true

  Maximum Length: 80

  Number that uniquely identifying the lot that the child genealogy object instance references to control the item in inventory. This attribute is used when the item is lot-controlled.
• ChildSerialNumber: string
  Read Only: true

  Maximum Length: 80

  Number that uniquely identifies the serial that the child genealogy object instance references. This attribute is used when item is serial-controlled.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParentGenealogyInstanceId: integer (int64)
  Value that uniquely identifies a parent genealogy object instance.
• ParentItemId: integer (int64)
  Title: Item Number

  Read Only: true

  Value that uniquely identifies the item of the child genealogy object instance. Either item identifier or item number can be used during the POST, PATCH, or GET actions.
• ParentItemNumber: string
  Read Only: true

  Maximum Length: 300

  Number that uniquely identifies the item of the child genealogy object instance. Either item identifier or item number can be used during the POST, PATCH, or GET actions.
• ParentLotNumber: string
  Read Only: true

  Maximum Length: 80

  Number that uniquely identifying the lot that the child genealogy object instance references to control the item in inventory. This attribute is used when the item is lot-controlled.
• ParentSerialNumber: string
  Read Only: true

  Maximum Length: 80

  Number that uniquely identifies the serial that the child genealogy object instance references. This attribute is used when item is serial-controlled.
• RelationshipId: integer (int64)
  Value that uniquely identifies the relationship between an instance of a parent genealogy object and an instance of a child genealogy object.

{
    "type":"object",
    "properties":{
        "ChildItemNumber":{
            "maxLength":"300",
            "type":"string",
            "description":"Number that uniquely identifies the item of the child genealogy object instance. Either item identifier or item number can be used during the POST, PATCH or GET actions.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChildSerialNumber":{
            "maxLength":"80",
            "type":"string",
            "description":"Number that uniquely identifies the serial that the child genealogy object instance references. This attribute is used when item is serial-controlled.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentSerialNumber":{
            "maxLength":"80",
            "type":"string",
            "description":"Number that uniquely identifies the serial that the child genealogy object instance references. This attribute is used when item is serial-controlled.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentLotNumber":{
            "maxLength":"80",
            "type":"string",
            "description":"Number that uniquely identifying the lot that the child genealogy object instance references to control the item in inventory. This attribute is used when the item is lot-controlled.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChildLotNumber":{
            "maxLength":"80",
            "type":"string",
            "description":"Number that uniquely identifying the lot that the child genealogy object instance references to control the item in inventory. This attribute is used when the item is lot-controlled.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentItemId":{
            "title":"Item Number",
            "type":"integer",
            "description":"Value that uniquely identifies the item of the child genealogy object instance. Either item identifier or item number can be used during the POST, PATCH, or GET actions.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParentItemNumber":{
            "maxLength":"300",
            "type":"string",
            "description":"Number that uniquely identifies the item of the child genealogy object instance. Either item identifier or item number can be used during the POST, PATCH, or GET actions.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipId":{
            "type":"integer",
            "description":"Value that uniquely identifies the relationship between an instance of a parent genealogy object and an instance of a child genealogy object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ChildGenealogyInstanceId":{
            "type":"integer",
            "description":"Value that uniquely identifies a child genealogy object instance.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParentGenealogyInstanceId":{
            "type":"integer",
            "description":"Value that uniquely identifies a parent genealogy object instance.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ActiveEndDate":{
            "type":"string",
            "description":"Date when a genealogy relationship is no longer active.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ChildItemId":{
            "title":"Item Number",
            "type":"integer",
            "description":"Value that uniquely identifies the item of the child genealogy object instance. Either item identifier or item number can be used during the POST, PATCH, or GET actions.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "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