Jump to

• Request
• Response
• Examples

Create multiple change order relationship rules

post

/fscmRestApi/resources/11.13.18.05/productChangeOrdersV2/{productChangeOrdersV2UniqID}/child/changeOrderRelationships/{changeOrderRelationshipsUniqID}/child/relationshipRules

Request

Path Parameters

• changeOrderRelationshipsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Change Order Relationships resource and used to uniquely identify an instance of Change Order Relationships. The client should not generate the hash key value. Instead, the client should query on the Change Order Relationships collection resource in order to navigate to a specific instance of Change Order Relationships to get the hash key.
• productChangeOrdersV2UniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Product Change Orders Version 2 resource and used to uniquely identify an instance of Product Change Orders Version 2. The client should not generate the hash key value. Instead, the client should query on the Product Change Orders Version 2 collection resource in order to navigate to a specific instance of Product Change Orders Version 2 to get the hash key.

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

• DestinationObjectType: string
  Maximum Length: 30

  Destination object type of the change order object relationship.
• DestinationRuleStatus: string
  Maximum Length: 255

  Destination object workflow status defined in the relationship rule.
• RelationshipId: integer (int64)
  Relationship ID of the change order object relationship.
• RelationshipRuleId: integer (int64)
  Relationship rule ID of the change order object relationship.
• SourceObjectType: string
  Maximum Length: 30

  Source object type of the change order object relationship.
• SourceRuleStatus: string
  Maximum Length: 255

  Source object workflow status defined in the relationship rule.

{
    "type":"object",
    "properties":{
        "DestinationRuleStatus":{
            "maxLength":255,
            "type":"string",
            "description":"Destination object workflow status defined in the relationship rule.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "RelationshipId":{
            "type":"integer",
            "description":"Relationship ID of the change order object relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            }
        },
        "RelationshipRuleId":{
            "type":"integer",
            "description":"Relationship rule ID of the change order object relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            }
        },
        "DestinationObjectType":{
            "maxLength":30,
            "type":"string",
            "description":"Destination object type of the change order object relationship.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "SourceRuleStatus":{
            "maxLength":255,
            "type":"string",
            "description":"Source object workflow status defined in the relationship rule.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "SourceObjectType":{
            "maxLength":30,
            "type":"string",
            "description":"Source object type of the change order object 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(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 : productChangeOrdersV2-changeOrderRelationships-relationshipRules-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date when the relationship rule was created.
• DestinationObjectID: integer (int64)
  Read Only: true

  Destination object ID of the relationship of the change order object.
• DestinationObjectNumber: string
  Read Only: true

  Maximum Length: 255

  Number that identifies the destination object.
• DestinationObjectType: string
  Maximum Length: 30

  Destination object type of the change order object relationship.
• DestinationRuleStatus: string
  Maximum Length: 255

  Destination object workflow status defined in the relationship rule.
• LastUpdateDate: string (date-time)
  Read Only: true

  User who most recently updated the relationship rule.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Date when the relationship rule was updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RelationshipId: integer (int64)
  Relationship ID of the change order object relationship.
• RelationshipRuleId: integer (int64)
  Relationship rule ID of the change order object relationship.
• SourceObjectId: integer (int64)
  Read Only: true

  Source object ID of the relationship of the change order object.
• SourceObjectNumber: string
  Read Only: true

  Maximum Length: 255

  Number that identifies the source object.
• SourceObjectType: string
  Maximum Length: 30

  Source object type of the change order object relationship.
• SourceRuleStatus: string
  Maximum Length: 255

  Source object workflow status defined in the relationship rule.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Date when the relationship rule was updated.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the relationship rule was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the relationship rule.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "DestinationRuleStatus":{
            "maxLength":255,
            "type":"string",
            "description":"Destination object workflow status defined in the relationship rule.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "RelationshipRuleId":{
            "type":"integer",
            "description":"Relationship rule ID of the change order object relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "DestinationObjectType":{
            "maxLength":30,
            "type":"string",
            "description":"Destination object type of the change order object relationship.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "SourceRuleStatus":{
            "maxLength":255,
            "type":"string",
            "description":"Source object workflow status defined in the relationship rule.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "SourceObjectType":{
            "maxLength":30,
            "type":"string",
            "description":"Source object type of the change order object relationship.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceObjectId":{
            "type":"integer",
            "description":"Source object ID of the relationship of the change order object.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DestinationObjectNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the destination object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipId":{
            "type":"integer",
            "description":"Relationship ID of the change order object relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "SourceObjectNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the source object.",
            "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"
            }
        },
        "DestinationObjectID":{
            "type":"integer",
            "description":"Destination object ID of the relationship of the change order object.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"User who most recently updated the relationship rule.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "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 how to add a relationship rule.

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/productChangeOrdersV2/productChangeOrdersV2UniqID/child/changeOrderRelationships/changeOrderRelationshipsUniqID/child/relationshipRules"

For example:

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/productChangeOrdersV2/300100618383864/child/changeOrderRelationships/300100618384476/child/relationshipRules"

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 updates.

{
"SourceRuleStatus": "Open",
"DestinationRuleStatus": "Approval"
}

Example Response Body

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

{
    "RelationshipId": 300100618384476,
    "RelationshipRuleId": 300100618389345,
    "SourceObjectId": 300100618383864,
    "SourceObjectNumber": "ECO12345",
    "SourceObjectType": "CHANGE",
    "SourceRuleStatus": "Open",
    "DestinationObjectID": 300100618384461,
    "DestinationObjectNumber": "PR1234",
    "DestinationObjectType": "PROBLEM_REPORT",
    "DestinationRuleStatus": "Approval",
    "CreatedBy": "PLM_AUTO",
    "CreationDate": "2023-10-25T17:42:14+00:00",
    "LastUpdateDate": "2023-10-25T17:42:14.200+00:00",
    "LastUpdatedBy": "PLM_AUTO",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/productChangeOrdersV2/300100618383864/child/changeOrderRelationships/300100618384476/child/relationshipRules/300100618389345",
            "name": "relationshipRules",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/productChangeOrdersV2/300100618383864/child/changeOrderRelationships/300100618384476/child/relationshipRules/300100618389345",
            "name": "relationshipRules",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/productChangeOrdersV2/300100618383864/child/changeOrderRelationships/300100618384476",
            "name": "changeOrderRelationships",
            "kind": "item"
        }
    ]
}

Back to Top