Jump to

• Request
• Response

Create an asset relationship

post

/fscmRestApi/resources/11.13.18.05/installedBaseAssets/{AssetId}/child/relationships

Request

Path Parameters

• AssetId(required): integer(int64)
  Value that uniquely identifies the asset. The application generates this value when it creates the asset. This attribute is read-only.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AssetId: integer (int64)
  Value that uniquely identifies the child asset in the structure. You must provide the value that identifies the child asset to create the relationship.
• AssetNumber: string
  Maximum Length: 255

  Number that uniquely identifies the child asset in the structure. This attribute is read-only.
• RelationshipId: integer (int64)
  Value that uniquely identifies the asset relationship. The application creates this value when it creates the asset relationship. This attribute is read-only.

{
    "type":"object",
    "properties":{
        "AssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the child asset in the structure. You must provide the value that identifies the child asset to create the relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AssetNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that uniquely identifies the child asset in the structure. This attribute is read-only.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RelationshipId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset relationship. The application creates this value when it creates the asset relationship. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"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 : installedBaseAssets-relationships-item-response

Type: object

Show Source

• AssetId: integer (int64)
  Value that uniquely identifies the child asset in the structure. You must provide the value that identifies the child asset to create the relationship.
• AssetNumber: string
  Maximum Length: 255

  Number that uniquely identifies the child asset in the structure. This attribute is read-only.
• ItemNumber: string
  Read Only: true

  Maximum Length: 300

  Number that uniquely identifies the item that the child asset references.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LogicalObjectId: integer (int64)
  Read Only: true

  Value that uniquely identifies the superlative relationship (As Sold Structure) to present the sales view of the customer assets. This attribute is read-only.
• RelationshipId: integer (int64)
  Value that uniquely identifies the asset relationship. The application creates this value when it creates the asset relationship. This attribute is read-only.
• SerialNumber: string
  Title: Serial Number

  Read Only: true

  Maximum Length: 80

  Serial number of the asset. You must provide the serial number in combination with the item to identify the asset.

{
    "type":"object",
    "properties":{
        "AssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the child asset in the structure. You must provide the value that identifies the child asset to create the relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssetNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that uniquely identifies the child asset in the structure. This attribute is read-only.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Number that uniquely identifies the item that the child asset references.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LogicalObjectId":{
            "type":"integer",
            "description":"Value that uniquely identifies the superlative relationship (As Sold Structure) to present the sales view of the customer assets. This attribute is read-only.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RelationshipId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset relationship. The application creates this value when it creates the asset relationship. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SerialNumber":{
            "title":"Serial Number",
            "maxLength":80,
            "type":"string",
            "description":"Serial number of the asset. You must provide the serial number in combination with the item to identify the asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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