Jump to

• Request
• Response
• Examples

Update a cyclic relationship setup

patch

/fscmRestApi/resources/11.13.18.05/relatedItemTypes/{relatedItemTypesUniqID}

Request

Path Parameters

• relatedItemTypesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Related Item Types resource and used to uniquely identify an instance of Related Item Types. The client should not generate the hash key value. Instead, the client should query on the Related Item Types collection resource in order to navigate to a specific instance of Related Item Types 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• cyclicRelationshipFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true then the cyclic relationship is allowed. If false, it's not allowed. The default value is true.
• relatedItemType: string
  Maximum Length: 255

  Type of related item relationships. A list of accepted values is defined in the lookup type EGP_RELATIONSHIP_TYPES. Review the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.

{
    "type":"object",
    "properties":{
        "relatedItemType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of related item relationships. A list of accepted values is defined in the lookup type EGP_RELATIONSHIP_TYPES. Review the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "Meaning"
                ]
            }
        },
        "cyclicRelationshipFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true then the cyclic relationship is allowed. If false, it's not allowed. The default value is true.",
            "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 : relatedItemTypes-item-response

Type: object

Show Source

• cyclicRelationshipFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true then the cyclic relationship is allowed. If false, it's not allowed. The default value is true.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• relatedItemType: string
  Maximum Length: 255

  Type of related item relationships. A list of accepted values is defined in the lookup type EGP_RELATIONSHIP_TYPES. Review the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.

{
    "type":"object",
    "properties":{
        "relatedItemType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of related item relationships. A list of accepted values is defined in the lookup type EGP_RELATIONSHIP_TYPES. Review the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "Meaning"
                ]
            },
            "x-queryable":true
        },
        "cyclicRelationshipFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true then the cyclic relationship is allowed. If false, it's not allowed. The default value is true.",
            "nullable":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

Examples

This example describes how to update a cyclic relationship setup.

Example cURL Command

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

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/relatedItemTypes/relatedItemTypesUniqID"

For example:

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/relatedItemTypes/00030000000131000000164547505F52454C4154494F4E534849505F5459504553FFFFFFFF"

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.

{  
	"cyclicRelationshipFlag": false 
}

Example Response Body

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

{
	"relatedItemType": "Substitute",
	"cyclicRelationshipFlag": false,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/relatedItemTypes/00030000000131000000164547505F52454C4154494F4E534849505F54595045530000000131",
		"name": "relatedItemTypes",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/relatedItemTypes/00030000000131000000164547505F52454C4154494F4E534849505F54595045530000000131",
		"name": "relatedItemTypes",
		"kind": "item"
	}
	]
}

Back to Top