Jump to

• Request
• Response
• Examples

Create one relationship

post

/fscmRestApi/resources/11.13.18.05/productChangeOrders/{ChangeId}/child/relationships

Request

Path Parameters

• ChangeId(required): integer
  Value that uniquely identifies the change.

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.
• Upsert-Mode:
  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

• Description: string
  Description of the related object.
• DestObjId: integer (int64)
  Value that uniquely identifies the destination object.
• DestObjType: string
  Maximum Length: 30

  Value that indicates the type of the destination object.
• LatestFlag: boolean
  Value that indicates whether the related object is latest or not.
• Name: string
  Name of the related object.
• RelationshipType: string
  Title: Relationship Type

  Maximum Length: 30

  Value that indicates the type of the relationship.
• SrcObjId: integer (int64)
  Value that uniquely identifies the source object.
• SrcObjType: string
  Maximum Length: 30

  Value that indicates the type of the source object.
• Status: string
  Status of the related object.

{
    "type":"object",
    "properties":{
        "Status":{
            "type":"string",
            "description":"Status of the related object.",
            "nullable":true
        },
        "SrcObjId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Description":{
            "type":"string",
            "description":"Description of the related object.",
            "nullable":true
        },
        "RelationshipType":{
            "title":"Relationship Type",
            "maxLength":30,
            "type":"string",
            "description":"Value that indicates the type of the relationship.",
            "nullable":true
        },
        "LatestFlag":{
            "type":"boolean",
            "description":"Value that indicates whether the related object is latest or not.",
            "nullable":true
        },
        "DestObjId":{
            "type":"integer",
            "description":"Value that uniquely identifies the destination object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "DestObjType":{
            "maxLength":30,
            "type":"string",
            "description":"Value that indicates the type of the destination object.",
            "nullable":true
        },
        "SrcObjType":{
            "maxLength":30,
            "type":"string",
            "description":"Value that indicates the type of the source object.",
            "nullable":false
        },
        "Name":{
            "type":"string",
            "description":"Name of the related object.",
            "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(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 : productChangeOrders-relationships-item-response

Type: object

Show Source

• ChangeNotice: string
  Read Only: true

  Maximum Length: 255

  Number that identifies the change order associated with the item.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the relationship.
• CreationDate: string (date-time)
  Read Only: true

  Date when the relationship was created.
• Description: string
  Description of the related object.
• DestObjId: integer (int64)
  Value that uniquely identifies the destination object.
• DestObjType: string
  Maximum Length: 30

  Value that indicates the type of the destination object.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the relationship was most recently updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the relationship.
• LatestFlag: boolean
  Value that indicates whether the related object is latest or not.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Name of the related object.
• RelationshipId: integer (int64)
  Read Only: true

  Value that uniquely identifies the relationship of a change.
• RelationshipType: string
  Title: Relationship Type

  Maximum Length: 30

  Value that indicates the type of the relationship.
• SrcObjId: integer (int64)
  Value that uniquely identifies the source object.
• SrcObjType: string
  Maximum Length: 30

  Value that indicates the type of the source object.
• Status: string
  Status of the related object.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the relationship.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "type":"string",
            "description":"Status of the related object.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the relationship was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the relationship.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "type":"string",
            "description":"Description of the related object.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipType":{
            "title":"Relationship Type",
            "maxLength":30,
            "type":"string",
            "description":"Value that indicates the type of the relationship.",
            "nullable":true,
            "x-queryable":true
        },
        "LatestFlag":{
            "type":"boolean",
            "description":"Value that indicates whether the related object is latest or not.",
            "nullable":true,
            "x-queryable":true
        },
        "DestObjType":{
            "maxLength":30,
            "type":"string",
            "description":"Value that indicates the type of the destination object.",
            "nullable":true,
            "x-queryable":true
        },
        "SrcObjType":{
            "maxLength":30,
            "type":"string",
            "description":"Value that indicates the type of the source object.",
            "nullable":false,
            "x-queryable":true
        },
        "Name":{
            "type":"string",
            "description":"Name of the related object.",
            "nullable":true,
            "x-queryable":true
        },
        "SrcObjId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RelationshipId":{
            "type":"integer",
            "description":"Value that uniquely identifies the relationship of a change.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChangeNotice":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the change order associated with the item.",
            "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"
            }
        },
        "DestObjId":{
            "type":"integer",
            "description":"Value that uniquely identifies the destination object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the relationship was most recently updated.",
            "format":"date-time",
            "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."
        }
    }
}

Back to Top

Examples

This example describes how to create one relationship.

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.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/productChangeOrders/ChangeId/child/relationships"

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.

{
	"DestObjType": "CHANGE",
	"DestObjId": 300100169288112
}

Example Response Body

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

{
	"RelationshipId": 300100169305945,
	"RelationshipType": null,
	"CreatedBy": "PIMQA",
	"CreationDate": "2018-12-03T07:49:01+00:00",
	"LastUpdateDate": "2018-12-03T07:49:01.058+00:00",
	"LastUpdatedBy": "PIMQA",
	"DestObjType": "CHANGE",
	"DestObjId": 300100169288112,
	"SrcObjType": "CHANGE",
	"SrcObjId": 300100169287961,
	"Name": "jerr_eco3",
	"Description": "jerr_eco3",
	"Status": "Draft",
	"LatestFlag": "true",
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100169287961/child/relationships/300100169305945",
		"name": "relationships",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100169287961/child/relationships/300100169305945",
		"name": "relationships",
		"kind": "item"
	},
	{
		"rel": "parent",
		"href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100169287961",
		"name": "productChangeOrders",
		"kind": "item"
	}
	]
}

Back to Top