Jump to

• Request
• Response
• Examples

Create one relationship

post

/fscmRestApi/resources/11.13.18.05/customerAssets/{AssetId}/child/AssetStructure

Request

Path Parameters

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

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

• AssetId: integer (int64)
  Value that uniquely identifies the child asset in the structure. To add or remove a child asset of the asset that you are updating, you must provide the value that identifies the asset, the asset number, or the value that identifies the item and serial number.

{
    "type":"object",
    "properties":{
        "AssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the child asset in the structure. To add or remove a child asset of the asset that you are updating, you must provide the value that identifies the asset, the asset number, or the value that identifies the item and serial number.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : customerAssets-AssetStructure-item-response

Type: object

Show Source

• AssetId: integer (int64)
  Value that uniquely identifies the child asset in the structure. To add or remove a child asset of the asset that you are updating, you must provide the value that identifies the asset, the asset number, or the value that identifies the item and serial number.
• AssetNumber: string
  Title: Number

  Read Only: true

  Maximum Length: 80

  Number that uniquely identifies the asset. To add or remove a child asset of the asset that you are updating, you must provide the value that identifies the asset, the asset number, or the value that identifies the item and serial number.
• ItemNumber: string
  Read Only: true

  Maximum Length: 300

  Number that uniquely identifies the item that the child asset references. To add or remove a child asset of the asset that you are updating, you must provide the value that identifies the asset, the asset number, or the value that identifies the item and serial number.
• links: array Links
  Title: Links

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

  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. To add or remove a child asset of the asset that you are updating, you must provide the value that identifies the asset, the asset number, or the value that identifies the item and serial number.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Number that uniquely identifies the item that the child asset references. To add or remove a child asset of the asset that you are updating, you must provide the value that identifies the asset, the asset number, or the value that identifies the item and serial number.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SerialNumber":{
            "title":"Serial Number",
            "maxLength":80,
            "type":"string",
            "description":"Serial number of the asset. To add or remove a child asset of the asset that you are updating, you must provide the value that identifies the asset, the asset number, or the value that identifies the item and serial number.",
            "nullable":true,
            "readOnly":true,
            "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,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AssetNumber":{
            "title":"Number",
            "maxLength":80,
            "type":"string",
            "description":"Number that uniquely identifies the asset. To add or remove a child asset of the asset that you are updating, you must provide the value that identifies the asset, the asset number, or the value that identifies the item and serial number.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the child asset in the structure. To add or remove a child asset of the asset that you are updating, you must provide the value that identifies the asset, the asset number, or the value that identifies the item and serial number.",
            "format":"int64",
            "nullable":false,
            "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

Examples

This example describes how to create one relationship in one customer asset.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.action+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/customerAssets/AssetId/child/AssetStructure"

For example, the following command creates relationship 300100111139686 between child asset 300100111139572 and parent asset 300100111139547:

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.action+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/customerAssets/300100111139547/child/AssetStructure"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
"AssetId": 300100111139572
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
            "RelationshipId": 300100111139686,
            "AssetId": 300100111139572,
            "AssetNumber": "JR-Test-30440",
            "SerialNumber": null,
            "ItemNumber": "alm-lot-001"
}

Back to Top