Jump to

• Request
• Response

Create resource relationships

post

/fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/resourceRelationships

Request

Path Parameters

• PlanId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context: string
  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: string
  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: string
  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

{
    "type":"object",
    "properties":{
    }
}

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 : productionSchedulingPlans-resourceRelationships-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64
• CreationDate: string (date-time)
  Read Only: true
• DirectOnlyFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then direct feed is only between upstream and downstream resources. If false, then direct feed isn't just between upstream and downstream resources. This attribute doesn't have a default value.
• DownstreamGroupCode: string
  Read Only: true

  Maximum Length: 300

  Abbreviation that identifies the resource group for the resource that's downstream.
• DownstreamGroupId: integer (int64)
  Read Only: true

  Value that uniquely identifies the downstream resource group.
• DownstreamResourceCode: string
  Read Only: true

  Maximum Length: 300

  Abbreviation that identifies the resource for the resource that's downstream.
• DownstreamResourceId: integer (int64)
  Read Only: true

  Value that uniquely identifies the downstream resource.
• DownstreamWorkCenterCode: string
  Read Only: true

  Maximum Length: 100

  Abbreviation that identifies the work center for the operation that's downstream.
• DownstreamWorkCenterId: integer (int64)
  Read Only: true

  Value that uniquely identifies the downstream work center.
• LastUpdateDate: string (date-time)
  Read Only: true
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32
• links: array Links
  Title: Links

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

  Value that uniquely identifies the production schedule.
• Rank: integer (int32)
  Read Only: true

  Rank of the resource relationship record.
• RelationshipId: integer (int64)
  Read Only: true

  Value that uniquely identifies the resource relationship record.
• UpstreamGroupCode: string
  Read Only: true

  Maximum Length: 300

  Abbreviation that identifies the resource group for the resource that's upstream.
• UpstreamGroupId: integer (int64)
  Read Only: true

  Value that uniquely identifies the upstream resource group.
• UpstreamResourceCode: string
  Read Only: true

  Maximum Length: 300

  Abbreviation that identifies the resource that's upstream.
• UpstreamResourceId: integer (int64)
  Read Only: true

  Value that uniquely identifies the upstream production resource. It's a primary key of the upstream production resource.
• UpstreamWorkCenterCode: string
  Read Only: true

  Maximum Length: 100

  Abbreviation that identifies the work center for the operation that's upstream.
• UpstreamWorkCenterId: integer (int64)
  Read Only: true

  Value that uniquely identifies the upstream work center.

{
    "type":"object",
    "properties":{
        "DownstreamResourceCode":{
            "maxLength":300,
            "type":"string",
            "description":"Abbreviation that identifies the resource for the resource that's downstream.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DownstreamGroupId":{
            "type":"integer",
            "description":"Value that uniquely identifies the downstream resource group.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DownstreamWorkCenterCode":{
            "maxLength":100,
            "type":"string",
            "description":"Abbreviation that identifies the work center for the operation that's downstream.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DownstreamWorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the downstream work center.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production schedule.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DirectOnlyFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then direct feed is only between upstream and downstream resources. If false, then direct feed isn't just between upstream and downstream resources. This attribute doesn't have a default value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Rank":{
            "type":"integer",
            "description":"Rank of the resource relationship record.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "UpstreamResourceCode":{
            "maxLength":300,
            "type":"string",
            "description":"Abbreviation that identifies the resource that's upstream.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UpstreamGroupId":{
            "type":"integer",
            "description":"Value that uniquely identifies the upstream resource group.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UpstreamResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the upstream production resource. It's a primary key of the upstream production resource.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DownstreamGroupCode":{
            "maxLength":300,
            "type":"string",
            "description":"Abbreviation that identifies the resource group for the resource that's downstream.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DownstreamResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the downstream resource.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RelationshipId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource relationship record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UpstreamGroupCode":{
            "maxLength":300,
            "type":"string",
            "description":"Abbreviation that identifies the resource group for the resource that's upstream.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UpstreamWorkCenterCode":{
            "maxLength":100,
            "type":"string",
            "description":"Abbreviation that identifies the work center for the operation that's upstream.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UpstreamWorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the upstream work center.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "nullable":true,
            "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