Jump to

• Request
• Response

Get multiple rows from relationship tab of change request

get

/fscmRestApi/resources/11.13.18.05/productChangeRequests/{productChangeRequestsUniqID}/child/changeRequestRelationships

Request

Path Parameters

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

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds change request relationships by primary key
    Finder Variables
    • RelationshipId; integer; Find change request relationships by the relationship identifier.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ChangeNotice; string; Change Notice is a value that uniquely identifies the change request object.
  • CreatedBy; string; The user who created the product change request object.
  • CreationDateTime; string; Date when the change request relationship was created.
  • Description; string; Description of the change request object relationship
  • DestinationObjectId; integer; The destination object identifier of the relationship of the change request.
  • DestinationObjectType; string; The destination object type of relationship of the change request
  • LastUpdateDateTime; string; Date when the change request object relationship was last updated.
  • LastUpdatedBy; string; User who most recently updated the change request relationship.
  • LatestFlag; boolean; Contains one of the following values: true or false. If true, then the change request is related to another object. If false, then the change request isn't related to another object. The default value is false.
  • Name; string; The name of relationship of the change request
  • RelationshipId; integer; The relationship identifier of the change request.
  • RelationshipType; string; The relationship type of the change request relationship
  • SourceObjectId; integer; The source object identifier of the relationship of the change request.
  • SourceObjectType; string; The source object type of relationship of the change request
  • Status; string; The status of relationship of the change request
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

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 : productChangeRequests-changeRequestRelationships

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/productChangeRequests-changeRequestRelationships-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object productChangeRequests-changeRequestRelationships-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/productChangeRequests-changeRequestRelationships-item-response"
    }
}

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 : productChangeRequests-changeRequestRelationships-item-response

Type: object

Show Source

• ChangeNotice: string
  Read Only: true

  Maximum Length: 255

  Change Notice is a value that uniquely identifies the change request object.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the product change request object.
• CreationDateTime: string (date-time)
  Read Only: true

  Date when the change request relationship was created.
• Description: string
  Description of the change request object relationship
• DestinationObjectId: integer
  The destination object identifier of the relationship of the change request.
• DestinationObjectType: string
  The destination object type of relationship of the change request
• LastUpdateDateTime: string (date-time)
  Read Only: true

  Date when the change request object relationship was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the change request relationship.
• LatestFlag: boolean
  Contains one of the following values: true or false. If true, then the change request is related to another object. If false, then the change request isn't related to another object. The default value is false.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  The name of relationship of the change request
• RelationshipId: integer (int64)
  Read Only: true

  The relationship identifier of the change request.
• relationshipRules: array Change Order Relationship Rules
  Title: Change Order Relationship Rules

  The Relationship Rules resource manages rules related to relationships on change orders.
• RelationshipType: string
  Title: Relationship Type

  Maximum Length: 30

  The relationship type of the change request relationship
• SourceObjectId: integer
  Read Only: true

  The source object identifier of the relationship of the change request.
• SourceObjectType: string
  Read Only: true

  The source object type of relationship of the change request
• Status: string
  The status of relationship of the change request

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the change request relationship.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "type":"string",
            "description":"The status of relationship of the change request",
            "nullable":true,
            "x-queryable":true
        },
        "relationshipRules":{
            "title":"Change Order Relationship Rules",
            "type":"array",
            "description":"The Relationship Rules resource manages rules related to relationships on change orders.",
            "items":{
                "$ref":"#/components/schemas/productChangeRequests-changeRequestRelationships-relationshipRules-item-response"
            }
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the product change request object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "type":"string",
            "description":"Description of the change request object relationship",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDateTime":{
            "type":"string",
            "description":"Date when the change request object relationship was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipType":{
            "title":"Relationship Type",
            "maxLength":"30",
            "type":"string",
            "description":"The relationship type of the change request relationship",
            "nullable":true,
            "x-queryable":true
        },
        "LatestFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the change request is related to another object. If false, then the change request isn't related to another object. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "DestinationObjectType":{
            "type":"string",
            "description":"The destination object type of relationship of the change request",
            "nullable":true,
            "x-queryable":true
        },
        "SourceObjectType":{
            "type":"string",
            "description":"The source object type of relationship of the change request",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "type":"string",
            "description":"The name of relationship of the change request",
            "nullable":true,
            "x-queryable":true
        },
        "SourceObjectId":{
            "type":"integer",
            "description":"The source object identifier of the relationship of the change request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDateTime":{
            "type":"string",
            "description":"Date when the change request relationship was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipId":{
            "type":"integer",
            "description":"The relationship identifier of the change request.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ChangeNotice":{
            "maxLength":"255",
            "type":"string",
            "description":"Change Notice is a value that uniquely identifies the change request 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":"The destination object identifier of the relationship of the change request.",
            "nullable":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 : Change Order Relationship Rules

Type: array

Title: Change Order Relationship Rules

The Relationship Rules resource manages rules related to relationships on change orders.

Show Source

• Array of: object productChangeRequests-changeRequestRelationships-relationshipRules-item-response

{
    "title":"Change Order Relationship Rules",
    "type":"array",
    "description":"The Relationship Rules resource manages rules related to relationships on change orders.",
    "items":{
        "$ref":"#/components/schemas/productChangeRequests-changeRequestRelationships-relationshipRules-item-response"
    }
}

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."
        }
    }
}

Nested Schema : productChangeRequests-changeRequestRelationships-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"
    }
}

Back to Top