Jump to

• Request
• Response

Create one program file

post

/fscmRestApi/resources/11.13.18.05/productionResources/{ResourceId}/child/ProgramFileName

Request

Path Parameters

• ResourceId(required): integer(int64)
  Value that uniquely identifies the production resource. It's a primary key that the application generates when it creates a production resource.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• EquipmentProgramFileId: integer (int64)
  Value that uniquely identifies the program file's association with the equipment.
• OrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization. It's a primary key that the application generates when it creates an inventory organization.
• ProgramFileId: integer (int64)
  Value that uniquely identifies the document item that represents the name of the program file used by the equipment.
• ProgramFileName: string
  Maximum Length: 300

  Name of the document item that represents the name of the program file.
• ResourceId: integer (int64)
  Value that uniquely identifies the production resource. It's a primary key that the application generates when it creates a production resource.

{
    "type":"object",
    "properties":{
        "ProgramFileId":{
            "type":"integer",
            "description":"Value that uniquely identifies the document item that represents the name of the program file used by the equipment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EquipmentProgramFileId":{
            "type":"integer",
            "description":"Value that uniquely identifies the program file's association with the equipment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization. It's a primary key that the application generates when it creates an inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production resource. It's a primary key that the application generates when it creates a production resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ProgramFileName":{
            "maxLength":300,
            "type":"string",
            "description":"Name of the document item that represents the name of the program file.",
            "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:
  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 : productionResources-ProgramFileName-item-response

Type: object

Show Source

• CurrentRevision: string
  Read Only: true

  Maximum Length: 18

  Current revision of the document item that represents the current revision of the program file.
• EquipmentProgramFileId: integer (int64)
  Value that uniquely identifies the program file's association with the equipment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization. It's a primary key that the application generates when it creates an inventory organization.
• ProgramFileId: integer (int64)
  Value that uniquely identifies the document item that represents the name of the program file used by the equipment.
• ProgramFileName: string
  Maximum Length: 300

  Name of the document item that represents the name of the program file.
• ResourceCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the production resource.
• ResourceId: integer (int64)
  Value that uniquely identifies the production resource. It's a primary key that the application generates when it creates a production resource.

{
    "type":"object",
    "properties":{
        "ResourceCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the production resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production resource. It's a primary key that the application generates when it creates a production resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProgramFileName":{
            "maxLength":300,
            "type":"string",
            "description":"Name of the document item that represents the name of the program file.",
            "nullable":true,
            "x-queryable":true
        },
        "ProgramFileId":{
            "type":"integer",
            "description":"Value that uniquely identifies the document item that represents the name of the program file used by the equipment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EquipmentProgramFileId":{
            "type":"integer",
            "description":"Value that uniquely identifies the program file's association with the equipment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization. It's a primary key that the application generates when it creates an inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurrentRevision":{
            "maxLength":18,
            "type":"string",
            "description":"Current revision of the document item that represents the current revision of the program file.",
            "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